From 6ec9637ed6d05fb113dcf0fb79c4cea818557be2 Mon Sep 17 00:00:00 2001
From: Mario Zechner <badlogicgames@gmail.com>
Date: Mon, 4 Sep 2023 10:35:24 +0200
Subject: [PATCH] [phaser] Closes #2333, users can set the name of the game
 object factory function via window.SPINE_GAME_OBJECT_TYPE, see
 custom-spine-object-type.html.

---
 spine-ts/index.html                           |  3 ++
 .../example/custom-spine-object-type.html     | 49 +++++++++++++++++++
 spine-ts/spine-phaser/src/SpineGameObject.ts  |  2 +-
 spine-ts/spine-phaser/src/SpinePlugin.ts      |  7 ++-
 spine-ts/spine-phaser/src/keys.ts             |  1 -
 5 files changed, 56 insertions(+), 6 deletions(-)
 create mode 100644 spine-ts/spine-phaser/example/custom-spine-object-type.html
diff --git a/spine-ts/index.html b/spine-ts/index.html
index cbee081a6..99bd0ec89 100644
--- a/spine-ts/index.html
+++ b/spine-ts/index.html
@@ -83,6 +83,9 @@
             >Render to texture test</a
           >
         </li>
+        <li>
+          <a href="/spine-phaser/example/custom-spine-object-type.html">Custom object type</a>
+        </li>
       </ul>
       <li>Player</li>
       <ul>
diff --git a/spine-ts/spine-phaser/example/custom-spine-object-type.html b/spine-ts/spine-phaser/example/custom-spine-object-type.html
new file mode 100644
index 000000000..07b1bf8aa
--- /dev/null
+++ b/spine-ts/spine-phaser/example/custom-spine-object-type.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <script src="//cdn.jsdelivr.net/npm/phaser@3.55.2/dist/phaser.js"></script>
+    <script src="../dist/iife/spine-phaser.js"></script>
+    <title>Spine Phaser Example</title>
+</head>
+
+<body>
+    <h1>Basic example</h1>
+</body>
+<script>
+    window.SPINE_GAME_OBJECT_TYPE = "spineOfficial";
+
+    class BasicExample extends Phaser.Scene {
+        preload() {
+            this.load.spineBinary("spineboy-data", "assets/spineboy-pro.skel");
+            this.load.spineAtlas("spineboy-atlas", "assets/spineboy-pma.atlas");
+        }
+
+        create() {
+            const spineboy = this.add.spineOfficial(400, 500, 'spineboy-data', "spineboy-atlas");
+            spineboy.setInteractive();
+            spineboy.displayWidth = 200;
+            spineboy.displayHeight = spineboy.height / spineboy.width * 200;
+            this.input.enableDebug(spineboy, 0xff00ff);
+            spineboy.animationState.setAnimation(0, "walk", true);
+        }
+    }
+
+    new Phaser.Game({
+        type: Phaser.AUTO,
+        width: 800,
+        height: 600,
+        type: Phaser.WEBGL,
+        scene: [BasicExample],
+        plugins: {
+            scene: [
+                { key: "spine.SpinePlugin", plugin: spine.SpinePlugin, mapping: "spine" }
+            ]
+        }
+    });
+</script>
+
+</html>
\ No newline at end of file
diff --git a/spine-ts/spine-phaser/src/SpineGameObject.ts b/spine-ts/spine-phaser/src/SpineGameObject.ts
index 38b8af095..cadfdbaff 100644
--- a/spine-ts/spine-phaser/src/SpineGameObject.ts
+++ b/spine-ts/spine-phaser/src/SpineGameObject.ts
@@ -212,7 +212,7 @@ export class SpineGameObject extends DepthMixin(
     atlasKey: string,
     public boundsProvider: SpineGameObjectBoundsProvider = new SetupPoseBoundsProvider()
   ) {
-    super(scene, SPINE_GAME_OBJECT_TYPE);
+    super(scene, (window as any).SPINE_GAME_OBJECT_TYPE ? (window as any).SPINE_GAME_OBJECT_TYPE : SPINE_GAME_OBJECT_TYPE);
     this.setPosition(x, y);
 
     this.premultipliedAlpha = this.plugin.isAtlasPremultiplied(atlasKey);
diff --git a/spine-ts/spine-phaser/src/SpinePlugin.ts b/spine-ts/spine-phaser/src/SpinePlugin.ts
index 040a3f2c8..3c107b36a 100644
--- a/spine-ts/spine-phaser/src/SpinePlugin.ts
+++ b/spine-ts/spine-phaser/src/SpinePlugin.ts
@@ -28,7 +28,7 @@
  *****************************************************************************/
 
 import Phaser from "phaser";
-import { SPINE_ATLAS_CACHE_KEY, SPINE_CONTAINER_TYPE, SPINE_GAME_OBJECT_TYPE, SPINE_SKELETON_DATA_FILE_TYPE, SPINE_ATLAS_FILE_TYPE, SPINE_SKELETON_FILE_CACHE_KEY as SPINE_SKELETON_DATA_CACHE_KEY } from "./keys";
+import { SPINE_ATLAS_CACHE_KEY, SPINE_GAME_OBJECT_TYPE, SPINE_SKELETON_DATA_FILE_TYPE, SPINE_ATLAS_FILE_TYPE, SPINE_SKELETON_FILE_CACHE_KEY as SPINE_SKELETON_DATA_CACHE_KEY } from "./keys";
 import { AtlasAttachmentLoader, GLTexture, SceneRenderer, Skeleton, SkeletonBinary, SkeletonData, SkeletonJson, TextureAtlas } from "@esotericsoftware/spine-webgl"
 import { SpineGameObject, SpineGameObjectBoundsProvider } from "./SpineGameObject";
 import { CanvasTexture, SkeletonRenderer } from "@esotericsoftware/spine-canvas";
@@ -138,7 +138,7 @@ export class SpinePlugin extends Phaser.Plugins.ScenePlugin {
 			}
 			return Phaser.GameObjects.BuildGameObject(this.scene, gameObject, config);
 		}
-		pluginManager.registerGameObject(SPINE_GAME_OBJECT_TYPE, addSpineGameObject, makeSpineGameObject);
+		pluginManager.registerGameObject((window as any).SPINE_GAME_OBJECT_TYPE ? (window as any).SPINE_GAME_OBJECT_TYPE : SPINE_GAME_OBJECT_TYPE, addSpineGameObject, makeSpineGameObject);
 	}
 
 	boot () {
@@ -188,8 +188,7 @@ export class SpinePlugin extends Phaser.Plugins.ScenePlugin {
 	}
 
 	gameDestroy () {
-		this.pluginManager.removeGameObject(SPINE_GAME_OBJECT_TYPE, true, true);
-		this.pluginManager.removeGameObject(SPINE_CONTAINER_TYPE, true, true);
+		this.pluginManager.removeGameObject((window as any).SPINE_GAME_OBJECT_TYPE ? (window as any).SPINE_GAME_OBJECT_TYPE : SPINE_GAME_OBJECT_TYPE, true, true);
 		if (this.webGLRenderer) this.webGLRenderer.dispose();
 	}
 
diff --git a/spine-ts/spine-phaser/src/keys.ts b/spine-ts/spine-phaser/src/keys.ts
index c1761f2ea..f8d01d223 100644
--- a/spine-ts/spine-phaser/src/keys.ts
+++ b/spine-ts/spine-phaser/src/keys.ts
@@ -33,4 +33,3 @@ export const SPINE_LOADER_TYPE = "spine";
 export const SPINE_SKELETON_DATA_FILE_TYPE = "spineSkeletonData";
 export const SPINE_ATLAS_FILE_TYPE = "spineAtlasData";
 export const SPINE_GAME_OBJECT_TYPE = "spine";
-export const SPINE_CONTAINER_TYPE = "spineContainer";
