Extends

• PIXI.DisplayObjectContainer

Members

alpha :Number

The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.
Please note that an object with an alpha value of 0 is skipped during the render pass.

The value of this property does not reflect any alpha values set further up the display list.
To obtain that value please see the worldAlpha property.

Inherited From:

• PIXI.DisplayObject#alpha

Source - pixi/display/DisplayObject.js, line 63

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 375

cacheAsBitmap :Boolean

Sets if this DisplayObject should be cached as a bitmap.

When invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it
in a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a
performance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.

Cached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not
re-generate the cached bitmap automatically. To do that you need to call DisplayObject.updateCache.

To remove a cached bitmap, set this property to null.

Inherited From:

• PIXI.DisplayObject#cacheAsBitmap

Source - pixi/display/DisplayObject.js, line 763

<readonly> children :Array.<DisplayObject>

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

Type:

• Array.<DisplayObject>

Inherited From:

• PIXI.DisplayObjectContainer#children

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

filterArea :Rectangle

The rectangular area used by filters when rendering a shader for this DisplayObject.

Inherited From:

• PIXI.DisplayObject#filterArea

Source - pixi/display/DisplayObject.js, line 195

filters :Array

Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas
Renderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter
using DisplayObject.filterArea.

To remove filters, set this property to null.

Note: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a
filter will reset this DisplayObjects blend mode to NORMAL.

Inherited From:

• PIXI.DisplayObject#filters

Source - pixi/display/DisplayObject.js, line 710

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:

• PIXI.DisplayObjectContainer#height

Source - pixi/display/DisplayObjectContainer.js, line 600

hitArea :Rectangle|Circle|Ellipse|Polygon

This is the defined area that will pick up mouse / touch events. It is null by default.
Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

Type:

• Rectangle | Circle | Ellipse | Polygon

Inherited From:

• PIXI.DisplayObject#hitArea

Source - pixi/display/DisplayObject.js, line 89

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:

• PIXI.DisplayObjectContainer#ignoreChildInput

Source - pixi/display/DisplayObjectContainer.js, line 26

mask :PIXIGraphics

Sets a mask for this DisplayObject. A mask is an instance of a Graphics object.
When applied it limits the visible area of this DisplayObject to the shape of the mask.
Under a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer.
To remove a mask, set this property to null.

Inherited From:

• PIXI.DisplayObject#mask

Source - pixi/display/DisplayObject.js, line 675

name :string

The name of this object.

Default Value:

• _stage_root

Source - core/Stage.js, line 29

<readonly> parent :PIXIDisplayObjectContainer

The parent DisplayObjectContainer that this DisplayObject is a child of.
All DisplayObjects must belong to a parent in order to be rendered.
The root parent is the Stage object. This property is set automatically when the
DisplayObject is added to, or removed from, a DisplayObjectContainer.

Inherited From:

• PIXI.DisplayObject#parent

Source - pixi/display/DisplayObject.js, line 107

pivot :PIXIPoint

The pivot point of this DisplayObject that it rotates around. The values are expressed
in pixel values.

Inherited From:

• PIXI.DisplayObject#pivot

Source - pixi/display/DisplayObject.js, line 43

position :PIXIPoint

The coordinates, in pixels, of this DisplayObject, relative to its parent container.

The value of this property does not reflect any positioning happening further up the display list.
To obtain that value please see the worldPosition property.

Inherited From:

• PIXI.DisplayObject#position

Source - pixi/display/DisplayObject.js, line 20

renderable :Boolean

Should this DisplayObject be rendered by the renderer? An object with a renderable value of
false is skipped during the render pass.

Inherited From:

• PIXI.DisplayObject#renderable

Source - pixi/display/DisplayObject.js, line 98

rotation :Number

The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on
a right-handed orientation.

The value of this property does not reflect any rotation happening further up the display list.
To obtain that value please see the worldRotation property.

Inherited From:

• PIXI.DisplayObject#rotation

Source - pixi/display/DisplayObject.js, line 51

scale :PIXIPoint

The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject
at its default size. A value of 0.5 would scale this DisplayObject by half, and so on.

The value of this property does not reflect any scaling happening further up the display list.
To obtain that value please see the worldScale property.

Inherited From:

• PIXI.DisplayObject#scale

Source - pixi/display/DisplayObject.js, line 31

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 395

visible :Boolean

The visibility of this DisplayObject. A value of false makes the object invisible.
A value of true makes it visible. Please note that an object with a visible value of
false is skipped during the render pass. Equally a DisplayObject with visible false will
not render any of its children.

The value of this property does not reflect any visible values set further up the display list.
To obtain that value please see the worldVisible property.

Inherited From:

• PIXI.DisplayObject#visible

Source - pixi/display/DisplayObject.js, line 75

width :Number

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

Inherited From:

• PIXI.DisplayObjectContainer#width

Source - pixi/display/DisplayObjectContainer.js, line 571

<readonly> worldAlpha :Number

The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.
This value is the calculated total, based on the alpha values of all parents of this DisplayObjects
in the display list.

To obtain, and set, the local alpha value, see the alpha property.

Note: This property is only updated at the end of the updateTransform call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Inherited From:

• PIXI.DisplayObject#worldAlpha

Source - pixi/display/DisplayObject.js, line 119

<readonly> worldPosition :PIXIPoint

The coordinates, in pixels, of this DisplayObject within the world.

This property contains the calculated total, based on the positions of all parents of this
DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Inherited From:

• PIXI.DisplayObject#worldPosition

Source - pixi/display/DisplayObject.js, line 150

<readonly> worldRotation :Number

The rotation, in radians, of this DisplayObject.

This property contains the calculated total, based on the rotations of all parents of this
DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Inherited From:

• PIXI.DisplayObject#worldRotation

Source - pixi/display/DisplayObject.js, line 180

<readonly> worldScale :PIXIPoint

The global scale of this DisplayObject.

This property contains the calculated total, based on the scales of all parents of this
DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Inherited From:

• PIXI.DisplayObject#worldScale

Source - pixi/display/DisplayObject.js, line 165

worldVisible :Boolean

Indicates if this DisplayObject is visible, based on it, and all of its parents, visible property values.

Inherited From:

• PIXI.DisplayObject#worldVisible

Source - pixi/display/DisplayObject.js, line 632

x :Number

The horizontal position of the DisplayObject, in pixels, relative to its parent.
If you need the world position of the DisplayObject, use DisplayObject.worldPosition instead.

Inherited From:

• PIXI.DisplayObject#x

Source - pixi/display/DisplayObject.js, line 588

y :Number

The vertical position of the DisplayObject, in pixels, relative to its parent.
If you need the world position of the DisplayObject, use DisplayObject.worldPosition instead.

Inherited From:

• PIXI.DisplayObject#y

Source - pixi/display/DisplayObject.js, line 610

Methods

addChild(child) → {PIXI.DisplayObject}

Adds a child to the container.

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject to add to the container

Returns:

PIXI.DisplayObject -

The child that was added.

Inherited From:

• PIXI.DisplayObjectContainer#addChild

Source - pixi/display/DisplayObjectContainer.js, line 42

addChildAt(child, index) → {PIXI.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	PIXI.DisplayObject	The child to add
index	Number	The index to place the child in

Returns:

PIXI.DisplayObject -

The child that was added.

Inherited From:

• PIXI.DisplayObjectContainer#addChildAt

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 230

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	PIXI.DisplayObject	-

Returns:

Boolean -

Inherited From:

• PIXI.DisplayObjectContainer#contains

Source - pixi/display/DisplayObjectContainer.js, line 449

destroy()

Destroys the Stage and removes event listeners.

Source - core/Stage.js, line 355

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:

• PIXI.DisplayObjectContainer#getBounds

Source - pixi/display/DisplayObjectContainer.js, line 280

getChildAt(index) → {PIXI.DisplayObject}

Returns the child at the specified index

Parameters:

Name	Type	Description
index	Number	The index to get the child from

Returns:

PIXI.DisplayObject -

The child at the given index, if any.

Inherited From:

• PIXI.DisplayObjectContainer#getChildAt

Source - pixi/display/DisplayObjectContainer.js, line 153

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject instance to identify

Returns:

Number -

The index position of the child display object to identify

Inherited From:

• PIXI.DisplayObjectContainer#getChildIndex

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:

• PIXI.DisplayObjectContainer#getLocalBounds

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 182

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) → {PIXI.DisplayObject}

Removes a child from the container.

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject to remove

Returns:

PIXI.DisplayObject -

The child that was removed.

Inherited From:

• PIXI.DisplayObjectContainer#removeChild

Source - pixi/display/DisplayObjectContainer.js, line 171

removeChildAt(index) → {PIXI.DisplayObject}

Removes a child from the specified index position.

Parameters:

Name	Type	Description
index	Number	The index to get the child from

Returns:

PIXI.DisplayObject -

The child that was removed.

Inherited From:

• PIXI.DisplayObjectContainer#removeChildAt

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:

• PIXI.DisplayObjectContainer#removeChildren

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 328

setChildIndex(child, index)

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

Parameters:

Name	Type	Description
child	PIXI.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:

• PIXI.DisplayObjectContainer#setChildIndex

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	PIXI.DisplayObject	-
child2	PIXI.DisplayObject	-

Inherited From:

• PIXI.DisplayObjectContainer#swapChildren

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 165

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 213

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 290