Merge branch 'feature/post-render'

Author: samme

src/DisplayListWatcher.js

@@ -6,6 +6,7 @@ import WalkDisplayListObj from './WalkDisplayListObject'
 const { POSITIVE_INFINITY } = Number
 const TextureEvents = Phaser.Textures.Events
 const CacheEvents = Phaser.Cache.Events
+const CoreEvents = Phaser.Core.Events
 const KeyboardEvents = Phaser.Input.Keyboard.Events
 const SceneEvents = Phaser.Scenes.Events
 const { KeyCodes } = Phaser.Input.Keyboard
@@ -104,6 +105,7 @@ export class DisplayListWatcher extends Phaser.Plugins.ScenePlugin {
   }
 
   start() {
+    const { game } = this
     const { cache, events, input, make, renderer } = this.systems
     const fontCache = cache.bitmapFont
     const keyboard = input?.keyboard
@@ -119,7 +121,7 @@ export class DisplayListWatcher extends Phaser.Plugins.ScenePlugin {
       return
     }
 
-    events.on(SceneEvents.RENDER, this.render, this)
+    game.events.on(CoreEvents.POST_RENDER, this.render, this)
 
     this.camera = new Phaser.Cameras.Scene2D.Camera(0, 0, width, height)
       .setBounds(0, 0, POSITIVE_INFINITY, POSITIVE_INFINITY)
@@ -142,6 +144,7 @@ export class DisplayListWatcher extends Phaser.Plugins.ScenePlugin {
   }
 
   stop() {
+    const { game } = this
     const { cache, events, input, settings } = this.systems
     const keyboard = input?.keyboard
 
@@ -150,7 +153,8 @@ export class DisplayListWatcher extends Phaser.Plugins.ScenePlugin {
     cache.bitmapFont.events.off(CacheEvents.ADD, this.onFontCacheAdded, this)
 
     events.off(SceneEvents.UPDATE, this.update, this)
-    events.off(SceneEvents.RENDER, this.render, this)
+
+    game.events.off(CoreEvents.POST_RENDER, this.render, this)
 
     if (keyboard) {
       keyboard.off(KeyboardEvents.ANY_KEY_DOWN, this.onAnyKeyDown, this)

src/DisplayListWatcher.test.js

@@ -48,6 +48,11 @@ vi.mock('phaser', () => {
           ADD: 'add'
         }
       },
+      Core: {
+        Events: {
+          POST_RENDER: 'postrender'
+        }
+      },
       Scenes: {
         Events: {
           BOOT: 'boot',
@@ -214,7 +219,7 @@ describe('new DisplayListWatcher(scene, pluginManager)', () => {
   let pluginManager
 
   beforeEach(() => {
-    game = { plugins: null }
+    game = { events: new EventEmitter(), plugins: null }
     pluginManager = { game }
     game.plugins = pluginManager
     scene = {
@@ -467,13 +472,14 @@ describe('new DisplayListWatcher(scene, pluginManager)', () => {
     expect(updateSpy).toHaveBeenCalledTimes(1)
   })
 
-  test('after boot() and start(), scene RENDER event causes plugin render()', () => {
+  test('after boot() and start(), game POST_RENDER event causes plugin render()', () => {
     const plugin = new DisplayListWatcher(scene, pluginManager)
     const renderSpy = vi.spyOn(plugin, 'render')
 
     plugin.boot()
     plugin.start()
-    plugin.systems.events.emit(Phaser.Scenes.Events.RENDER)
+
+    game.events.emit(Phaser.Core.Events.POST_RENDER)
 
     expect(renderSpy).toHaveBeenCalledTimes(1)
   })
@@ -490,14 +496,15 @@ describe('new DisplayListWatcher(scene, pluginManager)', () => {
     expect(updateSpy).not.toHaveBeenCalled()
   })
 
-  test('after boot(), start(), stop(), scene RENDER event does not cause plugin render()', () => {
+  test('after boot(), start(), stop(), game POST_RENDER event does not cause plugin render()', () => {
     const plugin = new DisplayListWatcher(scene, pluginManager)
     const renderSpy = vi.spyOn(plugin, 'render')
 
     plugin.boot()
     plugin.start()
     plugin.stop()
-    plugin.systems.events.emit(Phaser.Scenes.Events.RENDER)
+
+    game.events.emit(Phaser.Core.Events.POST_RENDER)
 
     expect(renderSpy).not.toHaveBeenCalled()
   })