-->

Phaser. Stage

new Stage(game)

The Stage controls root level display objects upon which everything is displayed.
It also handles browser visibility handling and the pausing due to loss of focus.

Parameters:
Name Type Description
game Phaser.Game

Game reference to the currently running game.

Source - core/Stage.js, line 16

Extends

Members

backgroundColor :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'

Type:
  • number | string
Source - core/Stage.js, line 366

<readonly> children :Array.<DisplayObject>

[read-only] The array of children of this container.

Type:
Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 17

currentRenderOrderID :number

Reset each frame, keeps a count of the total number of objects updated.

Source - core/Stage.js, line 65

disableVisibilityChange :boolean

By default if the browser tab loses focus the game will pause.
You can stop that behavior by setting this property to true.
Note that the browser can still elect to pause your game if it wishes to do so,
for example swapping to another browser tab. This will cause the RAF callback to halt,
effectively pausing your game, even though no in-game pause event is triggered if you enable this property.

Source - core/Stage.js, line 40

exists :boolean

If exists is true the Stage and all children are updated, otherwise it is skipped.

Default Value:
  • true
Source - core/Stage.js, line 46

game :Phaser.Game

A reference to the currently running Game.

Source - core/Stage.js, line 21

height :Number

The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 600

ignoreChildInput :Boolean

If ignoreChildInput is false it will allow this objects children to be considered as valid for Input events.

If this property is true then the children will not be considered as valid for Input events.

Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 26

name :string

The name of this object.

Default Value:
  • _stage_root
Source - core/Stage.js, line 29

smoothed :boolean

Enable or disable texture smoothing for all objects on this Stage. Only works for bitmap/image textures. Smoothing is enabled by default. Set to true to smooth all sprites rendered on this Stage, or false to disable smoothing (great for pixel art)

Source - core/Stage.js, line 386

width :Number

The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 571

Methods

addChild(child) → {DisplayObject}

Adds a child to the container.

Parameters:
Name Type Description
child DisplayObject

The DisplayObject to add to the container

Returns:

The child that was added.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 42

addChildAt(child, index) → {DisplayObject}

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters:
Name Type Description
child DisplayObject

The child to add

index Number

The index to place the child in

Returns:

The child that was added.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 55

checkVisibility()

Starts a page visibility event listener running, or window.onpagehide/onpageshow if not supported by the browser.
Also listens for window.onblur and window.onfocus.

Source - core/Stage.js, line 221

contains(child) → {Boolean}

Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.

Parameters:
Name Type Description
child DisplayObject

-

Returns:
Boolean -
Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 449

destroy()

Destroys the Stage and removes event listeners.

Source - core/Stage.js, line 346

getBounds(targetCoordinateSpace) → {Rectangle}

Retrieves the global bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.

Parameters:
Name Type Argument Description
targetCoordinateSpace PIXIDisplayObject | PIXIMatrix <optional>

Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.

Returns:
Rectangle -

The rectangular bounding area

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 280

getChildAt(index) → {DisplayObject}

Returns the child at the specified index

Parameters:
Name Type Description
index Number

The index to get the child from

Returns:

The child at the given index, if any.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 153

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters:
Name Type Description
child DisplayObject

The DisplayObject instance to identify

Returns:
Number -

The index position of the child display object to identify

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 112

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle without any transformations. The calculation takes all visible children into consideration.

Returns:
Rectangle -

The rectangular bounding area

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 437

<internal> parseConfig(config)

Parses a Game configuration object.

Parameters:
Name Type Description
config object

The configuration object to parse.

Internal:
  • This member is internal (protected) and may be modified or removed in the future.
Source - core/Stage.js, line 101

postUpdate()

This is called automatically before the renderer runs and after the plugins have updated.
In postUpdate this is where all the final physics calculations and object positioning happens.
The objects are processed in the order of the display list.

Source - core/Stage.js, line 173

preUpdate()

This is called automatically after the plugins preUpdate and before the State.update.
Most objects have preUpdate methods and it's where initial movement and positioning is done.

Source - core/Stage.js, line 138

removeChild(child) → {DisplayObject}

Removes a child from the container.

Parameters:
Name Type Description
child DisplayObject

The DisplayObject to remove

Returns:

The child that was removed.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 171

removeChildAt(index) → {DisplayObject}

Removes a child from the specified index position.

Parameters:
Name Type Description
index Number

The index to get the child from

Returns:

The child that was removed.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 191

removeChildren(beginIndex, endIndex)

Removes all children from this container that are within the begin and end indexes.

Parameters:
Name Type Description
beginIndex Number

The beginning position. Default value is 0.

endIndex Number

The ending position. Default value is size of the container.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 213

setBackgroundColor(color)

Sets the background color for the Stage.

The color can be given as a hex string ('#RRGGBB'), a CSS color string ('rgb(r,g,b)'), or a numeric value (0xRRGGBB).

An alpha channel is not supported and will be ignored.

If you've set your game to be transparent then calls to setBackgroundColor are ignored.

Parameters:
Name Type Description
color number | string

The color of the background.

Source - core/Stage.js, line 319

setChildIndex(child, index)

Changes the position of an existing child in the display object container

Parameters:
Name Type Description
child DisplayObject

The child DisplayObject instance for which you want to change the index number

index Number

The resulting index number for the child display object

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 132

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters:
Name Type Description
child DisplayObject

-

child2 DisplayObject

-

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 85

update()

This is called automatically after the State.update, but before particles or plugins update.

Source - core/Stage.js, line 156

updateTransform()

Updates the transforms for all objects on the display list.
This overrides the Pixi default as we don't need the interactionManager, but do need the game property check.

Source - core/Stage.js, line 204

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 281
Phaser Copyright © 2012-2016 Photon Storm Ltd.
Documentation generated by JSDoc 3.4.0 on Fri Aug 26 2016 01:16:18 GMT+0100 (BST) using the DocStrap template.