fix(sdk): Children are now ordered by zIndex, then id in groups

Author: CGjupoulton

engine/modules/entities/src/main/resources/view/entity-module/BufferedGroup.js

@@ -7,7 +7,6 @@ export class BufferedGroup extends ContainerBasedEntity {
   initDisplay () {
     super.initDisplay()
     this.buffer = new PIXI.Container()
-    this.buffer.sortableChildren = true
     this.gameTexture = null
     this.graphics = new PIXI.Sprite()
     this.needsRender = true

engine/modules/entities/src/main/resources/view/entity-module/ContainerBasedEntity.js

@@ -13,7 +13,6 @@ export class ContainerBasedEntity extends Entity {
   initDisplay () {
     super.initDisplay()
     this.graphics = new PIXI.Container()
-    this.graphics.sortableChildren = true
   }
 
   updateDisplay (state, changed, globalData) {

engine/modules/entities/src/main/resources/view/entity-module/GraphicEntityModule.js

@@ -117,7 +117,6 @@ export class GraphicEntityModule {
     this.globalData.toPixel = (WIDTH / canvasData.width) * canvasData.oversampling
     this.globalData.mustResetTree = true
     api.container = this.container = container
-    container.sortableChildren = true
     this.entities.forEach((e) => {
       e.init()
     })
@@ -167,6 +166,7 @@ export class GraphicEntityModule {
           e.childrenContainer.addChild(child.container)
           child.parent = e
         })
+        this.sortContainerChildren(e.childrenContainer)
         e.notifyChange()
       }
     })
@@ -177,6 +177,13 @@ export class GraphicEntityModule {
         this.container.addChild(e.container)
       }
     })
+    this.sortContainerChildren(this.container)
+  }
+  
+  sortContainerChildren(container) {
+    container.children.sort(
+      (a,b) => a.zIndex === b.zIndex ? a.id - b.id : a.zIndex - b.zIndex
+    )
   }
 
   handleGlobalData (players, globalData) {

playground/misc/misc-3-release-notes.md

@@ -2,6 +2,16 @@
 
 The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases.
 
+## Next Release
+
+### 🎁 Features
+
+- `BufferedGroups` can now be used as masks.
+
+### 🐞 Bug fix
+
+- Children with equal `zIndices` are now rendered by order of insertion in `Groups` and `BufferedGroups`.
+
 ## 4.2.1
 
 ### 🐞 Bug fix