Phaser.Component. BringToTop

new BringToTop()

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

Source - gameobjects/components/BringToTop.js, line 12

Methods

bringToTop() → {PIXI.DisplayObject}

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.

Returns:

This instance.

Source - gameobjects/components/BringToTop.js, line 24

moveDown() → {PIXI.DisplayObject}

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.

Returns:

This instance.

Source - gameobjects/components/BringToTop.js, line 87

moveUp() → {PIXI.DisplayObject}

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.

Returns:

This instance.

Source - gameobjects/components/BringToTop.js, line 66

sendToBack() → {PIXI.DisplayObject}

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.

Returns:

This instance.

Source - gameobjects/components/BringToTop.js, line 45
Phaser Copyright © 2012-2016 Photon Storm Ltd.
Documentation generated by JSDoc 3.4.3 on Tue Dec 06 2016 23:48:58 GMT+0000 (GMT Standard Time) using the DocStrap template.