Class: BringToTop

Phaser.Component. BringToTop

new BringToTop()

The BringToTop Component features quick access to Group sorting related methods.

Source:
src/gameobjects/components/BringToTop.js line 12

Methods

bringToTop()

Brings this Game Object to the top of its parents display list. Visually this means it will render over the top of any old child in the same Group.

If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World, because the World is the root Group from which all Game Objects descend.

Source:
src/gameobjects/components/BringToTop.js line 24
Returns:

This instance.

Type
PIXI.DisplayObject

moveDown()

Moves this Game Object down one place in its parents display list. This call has no effect if the Game Object is already at the bottom of the display list.

If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World, because the World is the root Group from which all Game Objects descend.

Source:
src/gameobjects/components/BringToTop.js line 87
Returns:

This instance.

Type
PIXI.DisplayObject

moveUp()

Moves this Game Object up one place in its parents display list. This call has no effect if the Game Object is already at the top of the display list.

If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World, because the World is the root Group from which all Game Objects descend.

Source:
src/gameobjects/components/BringToTop.js line 66
Returns:

This instance.

Type
PIXI.DisplayObject

sendToBack()

Sends this Game Object to the bottom of its parents display list. Visually this means it will render below all other children in the same Group.

If this Game Object hasn't been added to a custom Group then this method will send it to the bottom of the Game World, because the World is the root Group from which all Game Objects descend.

Source:
src/gameobjects/components/BringToTop.js line 45
Returns:

This instance.

Type
PIXI.DisplayObject

phaser-ce@2.9.2 is on GitHub and NPM

Documentation generated by JSDoc 3.5.4 on 2017-11-09 using Tomorrow.