Extends

• PIXI.DisplayObjectContainer

Members

alpha :Number

The opacity of the object.

Inherited From:

• PIXI.DisplayObject#alpha

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

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 374

cacheAsBitmap :Boolean

Set if this display object is cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'null'

Inherited From:

• PIXI.DisplayObject#cacheAsBitmap

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

<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 area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Inherited From:

• PIXI.DisplayObject#filterArea

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

filters :Array.<Filter>

Sets the filters for the displayObject. IMPORTANT: This is a webGL only feature and will be ignored by the Canvas renderer.

To remove filters simply set this property to 'null'.

You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset this objects blend mode to NORMAL.

Type:

• Array.<Filter>

Inherited From:

• PIXI.DisplayObject#filters

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

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 61

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 62

mask :PIXI.Graphics

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

Inherited From:

• PIXI.DisplayObject#mask

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

name :string

The name of this object.

Default Value:

• _stage_root

Source - core/Stage.js, line 29

<readonly> parent :PIXI.DisplayObjectContainer

[read-only] The display object container that contains this display object.

Inherited From:

• PIXI.DisplayObject#parent

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

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From:

• PIXI.DisplayObject#pivot

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

position :Point

The coordinate of the object relative to the local coordinates of the parent.

Inherited From:

• PIXI.DisplayObject#position

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

renderable :Boolean

Can this object be rendered

Inherited From:

• PIXI.DisplayObject#renderable

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

rotation :Number

The rotation of the object in radians.

Inherited From:

• PIXI.DisplayObject#rotation

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

scale :Point

The scale factor of the object.

Inherited From:

• PIXI.DisplayObject#scale

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

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 394

visible :Boolean

The visibility of the object.

Inherited From:

• PIXI.DisplayObject#visible

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

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 32

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:

• PIXI.DisplayObject#worldAlpha

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

<readonly> worldPosition :Point

The position of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From:

• PIXI.DisplayObject#worldPosition

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

<readonly> worldRotation :Number

The rotation of the Display Object, in radians, based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From:

• PIXI.DisplayObject#worldRotation

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

<readonly> worldScale :Point

The scale of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From:

• PIXI.DisplayObject#worldScale

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

worldVisible :Boolean

[read-only] Indicates if the sprite is globally visible.

Inherited From:

• PIXI.DisplayObject#worldVisible

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

x :Number

The position of the displayObject on the x axis relative to the local coordinates of the parent.

Inherited From:

• PIXI.DisplayObject#x

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

y :Number

The position of the displayObject on the y axis relative to the local coordinates of the parent.

Inherited From:

• PIXI.DisplayObject#y

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

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 91

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 103

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 229

destroy()

Destroys the Stage and removes event listeners.

Source - core/Stage.js, line 354

generateTexture(resolution, scaleMode, renderer) → {PIXI.Texture}

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Parameters:

Name	Type	Description
resolution	Number	The resolution of the texture being generated
scaleMode	Number	See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
renderer	PIXI.CanvasRenderer | PIXI.WebGLRenderer	The renderer used to generate the texture.

Returns:

PIXI.Texture -

a texture of the graphics object

Inherited From:

• PIXI.DisplayObject#generateTexture

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

getBounds() → {Rectangle}

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

Returns:

Rectangle -

The rectangular bounding area

Inherited From:

• PIXI.DisplayObjectContainer#getBounds

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

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 194

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 159

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. 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 367

<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 calculatations and object positioning happens. The objects are processed in the order of the display list. The only exception to this is if the camera is following an object, in which case that is updated first.

Source - core/Stage.js, line 172

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 211

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 226

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 244

removeStageReference()

Removes the current stage reference from the container and all of its children.

Inherited From:

• PIXI.DisplayObjectContainer#removeStageReference

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

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 327

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 176

setStageReference(stage)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters:

Name	Type	Description
stage	Stage	the stage that the container will have as its current stage reference

Inherited From:

• PIXI.DisplayObjectContainer#setStageReference

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

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 134

toGlobal(position) → {Point}

Calculates the global position of the display object

Parameters:

Name	Type	Description
position	Point	The world origin to calculate from

Returns:

Point -

A point object representing the position of this object

Inherited From:

• PIXI.DisplayObject#toGlobal

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

toLocal(position, from) → {Point}

Calculates the local position of the display object relative to another point

Parameters:

Name	Type	Argument	Description
position	Point		The world origin to calculate from
from	PIXI.DisplayObject	<optional>	The DisplayObject to calculate the global position from

Returns:

Point -

A point object representing the position of this object

Inherited From:

• PIXI.DisplayObject#toLocal

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

update()

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

Source - core/Stage.js, line 156

updateCache()

Generates and updates the cached sprite for this object.

Inherited From:

• PIXI.DisplayObject#updateCache

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

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 212

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 289