Added z property to remaining game objects and updated TypeScript defs.

Author: photonstorm

build/phaser.d.ts

@@ -1885,6 +1885,7 @@ declare module Phaser {
         postUpdate(): void;
         preUpdate(): void;
         update(): void;
+        z: nummber;
     }
 
     class Group extends PIXI.DisplayObjectContainer {
@@ -1934,11 +1935,13 @@ declare module Phaser {
         forEachDead(callback: Function, callbackContext: Object): void;
         forEachExists(callback: Function, callbackContext: Object): void;
         getAt(index: number): any;
+        getBottom(): any;
         getFirstAlive(): any;
         getFirstDead(): any;
         getFirstExists(state: boolean): any;
         getIndex(child: any): number;
         getRandom(startIndex: number, length: number): any;
+        getTop(): any;
         iterate(key: string, value: any, returnType: number, callback?: Function, callbackContext?: Object): any;
         multiplyAll(property: string, amount: number, checkAlive: boolean, checkVisible: boolean): void;
         next(): void;
@@ -1957,6 +1960,8 @@ declare module Phaser {
         subAll(property: string, amount: number, checkAlive: boolean, checkVisible: boolean): void;
         swap(child1: any, child2: any): boolean;
         update(): void;
+        updateZ(): void;
+        z: nummber;
     }
 
     class Image extends PIXI.Sprite {
@@ -2002,6 +2007,7 @@ declare module Phaser {
         reset(x: number, y: number): Phaser.Image;
         revive(): Phaser.Image;
         update(): void;
+        z: nummber;
     }
 
     class Input {
@@ -3312,6 +3318,7 @@ declare module Phaser {
         reset(x: number, y: number, health?: number): Phaser.Sprite;
         revive(health?: number): Phaser.Sprite;
         update(): void;
+        z: nummber;
     }
 
     class SpriteBatch extends Phaser.Group {
@@ -3509,6 +3516,7 @@ declare module Phaser {
         setShadow(x?: number, y?: number, color?: Object, blur?: number): void;
         setStyle(style?: { font?: string; fill?: Object; align?: string; stroke?: string; strokeThickness?: number; wordWrap?: boolean; wordWrapWidth?: number; shadowOffsetX?: number; shadowOffsetY?: number; shadowColor?: string; shadowBlur?: number; }): void;
         update(): void;
+        z: nummber;
     }
 
     class Tile {
@@ -3682,6 +3690,7 @@ declare module Phaser {
         renderDebug(): void;
         resizeWorld(): void;
         updateMax(): void;
+        z: nummber;
     }
 
     class TilemapParser {
@@ -3745,6 +3754,7 @@ declare module Phaser {
         preUpdate(): void;
         stopScroll(): void;
         update(): void;
+        z: nummber;
     }
 
     class Time {

examples/groups/depth sort.js

@@ -29,13 +29,13 @@ function create() {
     //  This group will hold the main player + all the tree sprites to depth sort against
     group = game.add.group();
 
-    //  Create some trees, each in a unique location (otherwise we'll get sort flicker)
+    //  Create some trees, each in a unique location
     for (var i = 0; i < 200; i++)
     {
         createUniqueLocation();
     }
 
-    sprite = group.create(300, 32, 'phaser');
+    sprite = group.create(300, 28, 'phaser');
 
     group.sort();
 
@@ -46,20 +46,19 @@ function create() {
 
 function createUniqueLocation() {
 
-    var x = game.math.snapTo(game.world.randomX, 32) / 32;
-    var y = game.math.snapTo(game.world.randomY, 32) / 32;
-    y--;
+    do {
+        var x = game.math.snapTo(game.world.randomX, 32) / 32;
+        var y = game.math.snapTo(game.world.randomY, 32) / 32;
 
-    var idx = (y * 19) + x;
+        if (y > 17)
+        {
+            y = 17;
+        }
 
-    while (locs.indexOf(idx) !== -1)
-    {
-        x = game.math.snapTo(game.world.randomX, 32) / 32;
-        y = game.math.snapTo(game.world.randomY, 32) / 32;
-        y--;
-        idx = (y * 19) + x;
+        var idx = (y * 17) + x;
     }
-    
+    while (locs.indexOf(idx) !== -1)
+
     locs.push(idx);
 
     group.create(x * 32, y * 32, 'trees', game.rnd.integerInRange(0, 7));
@@ -92,8 +91,6 @@ function update() {
 
 function render() {
 
-    // game.debug.text(sprite.y, 32, 32);
-    // game.debug.text(group.getIndex(sprite), 32, 64);
-    // game.debug.text(sprite.z, 32, 64);
+    game.debug.text('Sprite z-depth: ' + sprite.z, 10, 20);
 
 }

src/core/Group.js

@@ -1072,6 +1072,8 @@ Phaser.Group.prototype.sort = function (index, order) {
         this.children.sort(this.descendingSortHandler.bind(this));
     }
 
+    this.updateZ();
+
 }
 
 /**

src/gameobjects/BitmapText.js

@@ -54,6 +54,11 @@ Phaser.BitmapText = function (game, x, y, font, text, size) {
     */
     this.type = Phaser.BITMAPTEXT;
 
+    /**
+    * @property {number} z - The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.
+    */
+    this.z = 0;
+
     /**
     * @property {Phaser.Point} world - The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.
     */

src/gameobjects/Graphics.js

@@ -42,6 +42,11 @@ Phaser.Graphics = function (game, x, y) {
     */
     this.type = Phaser.GRAPHICS;
 
+    /**
+    * @property {number} z - The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.
+    */
+    this.z = 0;
+
     /**
     * @property {Phaser.Point} world - The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.
     */

src/gameobjects/Text.js

@@ -48,6 +48,11 @@ Phaser.Text = function (game, x, y, text, style) {
     */
     this.type = Phaser.TEXT;
 
+    /**
+    * @property {number} z - The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.
+    */
+    this.z = 0;
+
     /**
     * @property {Phaser.Point} world - The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.
     */