Phaser Global

##

### Members

#### <constant> ANGLE_DOWN :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face down.

  Source - Phaser.js, line 339

#### <constant> ANGLE_LEFT :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face left.

  Source - Phaser.js, line 346

#### <constant> ANGLE_NORTH_EAST :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face north east.

  Source - Phaser.js, line 360

#### <constant> ANGLE_NORTH_WEST :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face north west.

  Source - Phaser.js, line 367

#### <constant> ANGLE_RIGHT :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face right.

  Source - Phaser.js, line 353

#### <constant> ANGLE_SOUTH_EAST :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face south east.

  Source - Phaser.js, line 374

#### <constant> ANGLE_SOUTH_WEST :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face south west.

  Source - Phaser.js, line 381

#### <constant> ANGLE_UP :integer

  The Angle (in degrees) a Game Object needs to be set to in order to face up.

  Source - Phaser.js, line 332

#### <constant> AUTO :integer

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

  Source - Phaser.js, line 31

#### <constant> BITMAPDATA :integer

  Game Object type.

  Source - Phaser.js, line 185

#### <constant> BITMAPTEXT :integer

  Game Object type.

  Source - Phaser.js, line 136

#### <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 - Phaser.js, line 499

#### <constant> BOTTOM_CENTER :integer

  A constant representing a bottom-center alignment or position.

  Source - Phaser.js, line 465

#### <constant> BOTTOM_LEFT :integer

  A constant representing a bottom-left alignment or position.

  Source - Phaser.js, line 458

#### <constant> BOTTOM_RIGHT :integer

  A constant representing a bottom-right alignment or position.

  Source - Phaser.js, line 472

#### <constant> BUTTON :integer

  Game Object type.

  Source - Phaser.js, line 101

#### <constant> CANVAS :integer

  Canvas Renderer.

  Source - Phaser.js, line 38

#### <constant> CANVAS_FILTER :integer

  Game Object type.

  Source - Phaser.js, line 192

#### <constant> CENTER :integer

  A constant representing a center alignment or position.

  Source - Phaser.js, line 430

#### <constant> CIRCLE :integer

  Game Object type.

  Source - Phaser.js, line 241

#### <constant> CREATURE :integer

  Game Object type.

  Source - Phaser.js, line 283

#### <constant> DOWN :integer

  Direction constant.

  Source - Phaser.js, line 87

#### <constant> ELLIPSE :integer

  Game Object type.

  Source - Phaser.js, line 206

#### <constant> EMITTER :integer

  Game Object type.

  Source - Phaser.js, line 171

#### <constant> GAMES :array

  An array of Phaser game instances.

  Source - Phaser.js, line 24

#### <constant> GRAPHICS :integer

  Game Object type.

  Source - Phaser.js, line 115

#### <constant> GROUP :integer

  Game Object type.

  Source - Phaser.js, line 143

#### <constant> HEADLESS :integer

  Headless renderer (not visual output)

  Source - Phaser.js, line 52

#### <constant> HORIZONTAL :integer

  A horizontal orientation

  Source - Phaser.js, line 304

#### <constant> IMAGE :integer

  Game Object type.

  Source - Phaser.js, line 108

#### <constant> LANDSCAPE :integer

  A landscape orientation

  Source - Phaser.js, line 318

#### <constant> LEFT :integer

  Direction constant.

  Source - Phaser.js, line 66

#### <constant> LEFT_BOTTOM :integer

  A constant representing a left-bottom alignment or position.

  Source - Phaser.js, line 423

#### <constant> LEFT_CENTER :integer

  A constant representing a left-center alignment or position.

  Source - Phaser.js, line 416

#### <constant> LEFT_TOP :integer

  A constant representing a left-top alignment or position.

  Source - Phaser.js, line 409

#### <constant> LINE :integer

  Game Object type.

  Source - Phaser.js, line 255

#### <constant> MATRIX :integer

  Game Object type.

  Source - Phaser.js, line 262

#### <constant> NONE :integer

  Direction constant.

  Source - Phaser.js, line 59

#### <constant> PENDING_ATLAS :integer

  Game Object type.

  Source - Phaser.js, line 297

#### <constant> POINT :integer

  Game Object type.

  Source - Phaser.js, line 269

#### <constant> POINTER :integer

  Game Object type.

  Source - Phaser.js, line 227

#### <constant> POLYGON :integer

  Game Object type.

  Source - Phaser.js, line 178

#### <constant> PORTRAIT :integer

  A portrait orientation

  Source - Phaser.js, line 325

#### <constant> RECTANGLE :integer

  Game Object type.

  Source - Phaser.js, line 248

#### <constant> RENDERTEXTURE :integer

  Game Object type.

  Source - Phaser.js, line 150

#### <constant> RETROFONT :integer

  Game Object type.

  Source - Phaser.js, line 220

#### <constant> RIGHT :integer

  Direction constant.

  Source - Phaser.js, line 73

#### <constant> RIGHT_BOTTOM :integer

  A constant representing a right-bottom alignment or position.

  Source - Phaser.js, line 451

#### <constant> RIGHT_CENTER :integer

  A constant representing a right-center alignment or position.

  Source - Phaser.js, line 444

#### <constant> RIGHT_TOP :integer

  A constant representing a right-top alignment or position.

  Source - Phaser.js, line 437

#### <constant> ROPE :integer

  Game Object type.

  Source - Phaser.js, line 234

#### <constant> ROUNDEDRECTANGLE :integer

  Game Object type.

  Source - Phaser.js, line 276

#### <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 | Default | Description
  --- | --- | --- | ---
  `Phaser.scaleModes` | Object |  |
  `scaleModes.DEFAULT` | Number | LINEAR |
  `scaleModes.LINEAR` | Number |  | Smooth scaling
  `scaleModes.NEAREST` | Number |  | Pixelating scaling

  Source - Phaser.js, line 532

#### <constant> SPRITE :integer

  Game Object type.

  Source - Phaser.js, line 94

#### <constant> SPRITEBATCH :integer

  Game Object type.

  Source - Phaser.js, line 213

#### <constant> TEXT :integer

  Game Object type.

  Source - Phaser.js, line 122

#### <constant> TILEMAP :integer

  Game Object type.

  Source - Phaser.js, line 157

#### <constant> TILEMAPLAYER :integer

  Game Object type.

  Source - Phaser.js, line 164

#### <constant> TILESPRITE :integer

  Game Object type.

  Source - Phaser.js, line 129

#### <constant> TOP_CENTER :integer

  A constant representing a top-center alignment or position.

  Source - Phaser.js, line 395

#### <constant> TOP_LEFT :integer

  A constant representing a top-left alignment or position.

  Source - Phaser.js, line 388

#### <constant> TOP_RIGHT :integer

  A constant representing a top-right alignment or position.

  Source - Phaser.js, line 402

#### <constant> UP :integer

  Direction constant.

  Source - Phaser.js, line 80

#### <constant> VERSION :string

  The Phaser version number.

  Source - Phaser.js, line 17

#### <constant> VERTICAL :integer

  A vertical orientation

  Source - Phaser.js, line 311

#### <constant> VIDEO :integer

  Game Object type.

  Source - Phaser.js, line 290

#### <constant> WEBGL :integer

  WebGL Renderer.

  Source - Phaser.js, line 45

#### <constant> WEBGL_FILTER :integer

  Game Object type.

  Source - Phaser.js, line 199

### Methods

#### displayList(displayObject)

  Call this function from the Dev Tools console.

  It will scan the display list and output all of the Objects it finds, and their renderOrderIDs.

  Note Requires a browser that supports console.group and console.groupEnd (such as Chrome)

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `displayObject` | Object | <optional> | The displayObject level display object to start from. Defaults to the World.

  Source - utils/Debug.js, line 844

#### emit(eventName) → {Boolean}

  Emit an event to all registered event listeners.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `eventName` | String | The name of the event.

  ##### Returns:

  Boolean -

  Indication if we've emitted an event.

  Source - plugins/path/EventTarget.js, line 54

#### listeners(eventName) → {Array}

  Return a list of assigned event listeners.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `eventName` | String | The events that should be listed.

  ##### Returns:

  Array -

  An array of listener functions

  Source - plugins/path/EventTarget.js, line 41

#### mixin(object)

  Mixes in the properties of the EventTarget prototype onto another object

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `object` | Object | The obj to mix into

  Source - plugins/path/EventTarget.js, line 34

#### off(eventName, callback)

  Remove event listeners.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `eventName` | String | The event we want to remove.
  `callback` | function | The listener that we need to find.

  Source - plugins/path/EventTarget.js, line 143

#### on(eventName, callback)

  Register a new EventListener for the given event.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `eventName` | String | Name of the event.
  `callback` | Functon | fn Callback function.

  Source - plugins/path/EventTarget.js, line 107

#### once(eventName, callback)

  Add an EventListener that's only called once.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `eventName` | String | Name of the event.
  `callback` | function | Callback function.

  Source - plugins/path/EventTarget.js, line 124

#### Phaser.Path#numPoints return {number} The total number of PathPoints in this Path.()

  The total number of PathPoints in this Path.

  Source - plugins/path/Path.js, line 536

#### removeAllListeners(eventName)

  Remove all listeners or only the listeners for the specified event.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `eventName` | String | The event you want to remove all listeners for.

  Source - plugins/path/EventTarget.js, line 173

#### stopImmediatePropagation()

  Stops the propagation of events to sibling listeners (no longer calls any listeners).

  Source - plugins/path/EventTarget.js, line 277

#### stopPropagation()

  Stops the propagation of events up the scene graph (prevents bubbling).

  Source - plugins/path/EventTarget.js, line 268

### 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 - core/Group.js, line 2958