mirror of
https://github.com/photonstorm/phaser
synced 2024-12-26 13:03:36 +00:00
96 lines
2.6 KiB
JavaScript
96 lines
2.6 KiB
JavaScript
/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2016 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* The BringToTop Component features quick access to Group sorting related methods.
|
|
*
|
|
* @class
|
|
*/
|
|
Phaser.Component.BringToTop = function () {};
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @method
|
|
* @return {PIXI.DisplayObject} This instance.
|
|
*/
|
|
Phaser.Component.BringToTop.prototype.bringToTop = function() {
|
|
|
|
if (this.parent)
|
|
{
|
|
this.parent.bringToTop(this);
|
|
}
|
|
|
|
return this;
|
|
|
|
};
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @method
|
|
* @return {PIXI.DisplayObject} This instance.
|
|
*/
|
|
Phaser.Component.BringToTop.prototype.sendToBack = function() {
|
|
|
|
if (this.parent)
|
|
{
|
|
this.parent.sendToBack(this);
|
|
}
|
|
|
|
return this;
|
|
|
|
};
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @method
|
|
* @return {PIXI.DisplayObject} This instance.
|
|
*/
|
|
Phaser.Component.BringToTop.prototype.moveUp = function () {
|
|
|
|
if (this.parent)
|
|
{
|
|
this.parent.moveUp(this);
|
|
}
|
|
|
|
return this;
|
|
|
|
};
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @method
|
|
* @return {PIXI.DisplayObject} This instance.
|
|
*/
|
|
Phaser.Component.BringToTop.prototype.moveDown = function () {
|
|
|
|
if (this.parent)
|
|
{
|
|
this.parent.moveDown(this);
|
|
}
|
|
|
|
return this;
|
|
|
|
};
|