Navigation
These archived docs are for Phaser 2.4.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Public Properties

<constant> AUTO : integer

AUTO renderer - picks between WebGL or Canvas based on device.

Source code: Phaser.js (Line 32)

<constant> BITMAPDATA : integer

Game Object type.

Source code: Phaser.js (Line 186)

<constant> BITMAPTEXT : integer

Game Object type.

Source code: Phaser.js (Line 137)

<constant> blendModes

Various blend modes supported by Pixi.

IMPORTANT: The WebGL renderer only supports the NORMAL, ADD, MULTIPLY and SCREEN blend modes.

Properties:
Name Type Description
blendModes.NORMAL Number
blendModes.ADD Number
blendModes.MULTIPLY Number
blendModes.SCREEN Number
blendModes.OVERLAY Number
blendModes.DARKEN Number
blendModes.LIGHTEN Number
blendModes.COLOR_DODGE Number
blendModes.COLOR_BURN Number
blendModes.HARD_LIGHT Number
blendModes.SOFT_LIGHT Number
blendModes.DIFFERENCE Number
blendModes.EXCLUSION Number
blendModes.HUE Number
blendModes.SATURATION Number
blendModes.COLOR Number
blendModes.LUMINOSITY Number
Source code: Phaser.js (Line 318)

<constant> BUTTON : integer

Game Object type.

Source code: Phaser.js (Line 102)

<constant> CANVAS : integer

Canvas Renderer.

Source code: Phaser.js (Line 39)

<constant> CANVAS_FILTER : integer

Game Object type.

Source code: Phaser.js (Line 193)

<constant> CIRCLE : integer

Game Object type.

Source code: Phaser.js (Line 242)

<constant> CREATURE : integer

Game Object type.

Source code: Phaser.js (Line 284)

<constant> DOWN : integer

Direction constant.

Source code: Phaser.js (Line 88)

<constant> ELLIPSE : integer

Game Object type.

Source code: Phaser.js (Line 207)

<constant> EMITTER : integer

Game Object type.

Source code: Phaser.js (Line 172)

<constant> GAMES :array

An array of Phaser game instances.

Source code: Phaser.js (Line 25)

<constant> GRAPHICS : integer

Game Object type.

Source code: Phaser.js (Line 116)

<constant> GROUP : integer

Game Object type.

Source code: Phaser.js (Line 144)

<constant> HEADLESS : integer

Headless renderer (not visual output)

Source code: Phaser.js (Line 53)

<constant> IMAGE : integer

Game Object type.

Source code: Phaser.js (Line 109)

<constant> LEFT : integer

Direction constant.

Source code: Phaser.js (Line 67)

<constant> LINE : integer

Game Object type.

Source code: Phaser.js (Line 256)

<constant> MATRIX : integer

Game Object type.

Source code: Phaser.js (Line 263)

<constant> NONE : integer

Direction constant.

Source code: Phaser.js (Line 60)

<constant> POINT : integer

Game Object type.

Source code: Phaser.js (Line 270)

<constant> POINTER : integer

Game Object type.

Source code: Phaser.js (Line 228)

<constant> POLYGON : integer

Game Object type.

Source code: Phaser.js (Line 179)

<constant> RECTANGLE : integer

Game Object type.

Source code: Phaser.js (Line 249)

<constant> RENDERTEXTURE : integer

Game Object type.

Source code: Phaser.js (Line 151)

<constant> RETROFONT : integer

Game Object type.

Source code: Phaser.js (Line 221)

Direction constant.

Source code: Phaser.js (Line 74)

<constant> ROPE : integer

Game Object type.

Source code: Phaser.js (Line 235)

<constant> ROUNDEDRECTANGLE : integer

Game Object type.

Source code: Phaser.js (Line 277)

<constant> scaleModes

The scale modes that are supported by Pixi.

The DEFAULT scale mode affects the default scaling mode of future operations. It can be re-assigned to either LINEAR or NEAREST, depending upon suitability.

Properties:
Name Type Description
Phaser.scaleModes Object
scaleModes.DEFAULT=LINEAR Number
scaleModes.LINEAR Number

Smooth scaling

scaleModes.NEAREST Number

Pixelating scaling

Source code: Phaser.js (Line 351)

<constant> SPRITE : integer

Game Object type.

Source code: Phaser.js (Line 95)

<constant> SPRITEBATCH : integer

Game Object type.

Source code: Phaser.js (Line 214)

<constant> TEXT : integer

Game Object type.

Source code: Phaser.js (Line 123)

<constant> TILEMAP : integer

Game Object type.

Source code: Phaser.js (Line 158)

<constant> TILEMAPLAYER : integer

Game Object type.

Source code: Phaser.js (Line 165)

<constant> TILESPRITE : integer

Game Object type.

Source code: Phaser.js (Line 130)

<constant> UP : integer

Direction constant.

Source code: Phaser.js (Line 81)

<constant> VERSION : string

The Phaser version number.

Source code: Phaser.js (Line 18)

<constant> VIDEO : integer

Game Object type.

Source code: Phaser.js (Line 291)

<constant> WEBGL : integer

WebGL Renderer.

Source code: Phaser.js (Line 46)

<constant> WEBGL_FILTER : integer

Game Object type.

Source code: Phaser.js (Line 200)

Type Definitions

DisplayObject

A display object is any object that can be rendered in the Phaser/pixi.js scene graph.

This includes Phaser.Group (groups are display objects!), Phaser.Sprite, Phaser.Button, Phaser.Text as well as PIXI.DisplayObject and all derived types.

Source code: core/Group.js (Line 2167)