Phaser Class: Camera

new Camera(game, id, x, y, width, height)

A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view. The game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x/y

Parameters:

Name	Type	Description
`game`	Phaser.Game	Game reference to the currently running game.
`id`	number	Not being used at the moment, will be when Phaser supports multiple camera
`x`	number	Position of the camera on the X axis
`y`	number	Position of the camera on the Y axis
`width`	number	The width of the view rectangle
`height`	number	The height of the view rectangle

Source:

core/Camera.js, line 22

Members

<static, constant> FOLLOW_LOCKON :number

Type:

number

Source:

core/Camera.js, line 89

<static, constant> FOLLOW_PLATFORMER :number

Type:

number

Source:

core/Camera.js, line 95

<static, constant> FOLLOW_TOPDOWN :number

Type:

number

Source:

core/Camera.js, line 101

<static, constant> FOLLOW_TOPDOWN_TIGHT :number

Type:

number

Source:

core/Camera.js, line 107

atLimit

Properties:

Name	Type	Description
`atLimit`	boolean	Whether this camera is flush with the World Bounds or not.

Source:

core/Camera.js, line 68

deadzone

Properties:

Name	Type	Description
`deadzone`	Phaser.Rectangle	Moving inside this Rectangle will not cause camera moving.

Source:

core/Camera.js, line 57

game

Properties:

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

Source:

core/Camera.js, line 27

height

The Cameras height. By default this is the same as the Game size and should not be adjusted for now.

Properties:

Name	Type	Description
`height`	number	Gets or sets the cameras height.

Source:

core/Camera.js, line 337

id

Properties:

Name	Type	Description
`id`	number	Reserved for future multiple camera set-ups.

Default Value:

Source:

core/Camera.js, line 38

screenView

Properties:

Name	Type	Description
`screenView`	Phaser.Rectangle	Used by Sprites to work out Camera culling.

Source:

core/Camera.js, line 52

target

Properties:

Name	Type	Description
`target`	Phaser.Sprite	If the camera is tracking a Sprite, this is a reference to it, otherwise null.

Default Value:

null

Source:

core/Camera.js, line 74

view

Camera view. The view into the world we wish to render (by default the game dimensions). The x/y values are in world coordinates, not screen coordinates, the width/height is how many pixels to render. Objects outside of this view are not rendered (unless set to ignore the Camera, i.e. UI?).

Properties:

Name	Type	Description
`view`	Phaser.Rectangle

Source:

core/Camera.js, line 47

visible

Properties:

Name	Type	Description
`visible`	boolean	Whether this camera is visible or not.

Default Value:

true

Source:

core/Camera.js, line 63

width

The Cameras width. By default this is the same as the Game size and should not be adjusted for now.

Properties:

Name	Type	Description
`width`	number	Gets or sets the cameras width.

Source:

core/Camera.js, line 320

world

Properties:

Name	Type	Description
`world`	Phaser.World	A reference to the game world.

Source:

core/Camera.js, line 32

x

The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds.

Properties:

Name	Type	Description
`x`	number	Gets or sets the cameras x position.

Source:

core/Camera.js, line 284

y

The Cameras y coordinate. This value is automatically clamped if it falls outside of the World bounds.

Properties:

Name	Type	Description
`y`	number	Gets or sets the cameras y position.

Source:

core/Camera.js, line 302

Methods

checkWorldBounds()

Method called to ensure the camera doesn't venture outside of the game world.

Source:

core/Camera.js, line 214

focusOnXY(x, y)

Move the camera focus to a location instantly.

Parameters:

Name	Type	Description
`x`	number	X position.
`y`	number	Y position.

Source:

core/Camera.js, line 151

follow(target, style)

Tells this camera which sprite to follow.

Parameters:

Name	Type	Argument	Description
`target`	Phaser.Sprite		The object you want the camera to track. Set to null to not follow anything.
`style`	number	<optional>	Leverage one of the existing "deadzone" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().

Source:

core/Camera.js, line 111

setPosition(x, y)

A helper function to set both the X and Y properties of the camera at once without having to use game.camera.x and game.camera.y.

Parameters:

Name	Type	Description
`x`	number	X position.
`y`	number	Y position.

Source:

core/Camera.js, line 252

setSize(width, height)

Sets the size of the view rectangle given the width and height in parameters.

Parameters:

Name	Type	Description
`width`	number	The desired width.
`height`	number	The desired height.

Source:

core/Camera.js, line 268

update()

Update focusing and scrolling.

Source:

core/Camera.js, line 164