vue-phaserjs 2.39.0 → 3.0.0

package/dist/index.js

@@ -1,7 +1,7 @@
 import { Fragment, computed, createCommentVNode, createElementBlock, createElementVNode, defineComponent, getCurrentInstance, inject, nextTick, onMounted, onUnmounted, openBlock, provide, ref, renderSlot, toValue, useTemplateRef, watch } from "vue";
 import { ID_SEPARATOR, InvalidOperationError, NotFoundError, NotInitializedError, Operation, checkIsPlainObject, takeOne, toKebabCase } from "@esposter/shared";
 import ClickOutside from "phaser4-rex-plugins/plugins/clickoutside.js";
-import { Animations, Cameras, Game, Loader, Scene, Scenes, Tilemaps, Tweens, Utils } from "phaser";
+import { Animations, Cameras, Core, Game, Loader, Scene, Scenes, Tilemaps, Tweens, Utils } from "phaser";
 import { defineStore, storeToRefs } from "pinia";
 import { parseTileset, parseXmlString } from "parse-tmx";
 //#region src/util/getDepthInsertIndex.ts
@@ -145,7 +145,8 @@ const useInitializeGameObjectSetters = (gameObject, configuration, emit, setterM
 			if (value !== void 0) emit(updateEvent, value);
 			else if (key in targetGameObject) emit(updateEvent, targetGameObject[key]);
 		});
-		setterWatchHandles.push(watch(() => toValue(configuration)[key], (newValue) => {
+		setterWatchHandles.push(watch(() => toValue(configuration)[key], (newValue, oldValue) => {
+			if (newValue === oldValue && (newValue === null || typeof newValue !== "object")) return;
 			const updater = () => {
 				setter(toValue(gameObject), emit)(newValue);
 				emit(updateEvent, newValue);
@@ -175,7 +176,6 @@ const usePhaserStore = defineStore("phaser", () => {
 		}
 	});
 	const sceneKey = ref();
-	const rootSceneKey = sceneKey;
 	const isSameScene = (newSceneKey) => newSceneKey === sceneKey.value;
 	const switchToScene = async (newSceneKey) => {
 		if (isSameScene(newSceneKey)) return;
@@ -199,9 +199,8 @@ const usePhaserStore = defineStore("phaser", () => {
 	const removeParallelScene = (scene, targetSceneKey) => {
 		const index = parallelSceneKeys.value.indexOf(targetSceneKey);
 		if (index === -1) return;
-		const parallelSceneKey = parallelSceneKeys.value[index];
 		parallelSceneKeys.value = parallelSceneKeys.value.toSpliced(index, 1);
-		scene.scene.stop(parallelSceneKey);
+		scene.scene.stop(targetSceneKey);
 	};
 	return {
 		game,
@@ -210,7 +209,7 @@ const usePhaserStore = defineStore("phaser", () => {
 		parallelSceneKeys,
 		prioritizedParallelSceneKeys,
 		removeParallelScene,
-		rootSceneKey,
+		rootSceneKey: sceneKey,
 		switchToScene
 	};
 });
@@ -299,9 +298,9 @@ const DepthSetterMap = { depth: (gameObject) => (value) => {
 	if (value === void 0) return;
 	gameObject.setDepth(value);
 	if (!gameObject.parentContainer) return;
-	const i = getDepthInsertIndex(gameObject.parentContainer.list, gameObject.depth);
-	if (i === -1) gameObject.parentContainer.bringToTop(gameObject);
-	else gameObject.parentContainer.moveTo(gameObject, Math.max(i - 1, 0));
+	const depthInsertIndex = getDepthInsertIndex(gameObject.parentContainer.list, gameObject.depth);
+	if (depthInsertIndex === -1) gameObject.parentContainer.bringToTop(gameObject);
+	else gameObject.parentContainer.moveTo(gameObject, Math.max(depthInsertIndex - 1, 0));
 } };
 //#endregion
 //#region src/util/setterMap/components/OriginSetterMap.ts
@@ -395,8 +394,8 @@ const TweenSetterMap = {
 	},
 	tweenchain: (gameObject, emit) => (value) => {
 		if (!value) return;
-		gameObject.scene.add.tweenchain(value.map((c) => ({
-			...c,
+		gameObject.scene.add.tweenchain(value.map((configuration) => ({
+			...configuration,
 			targets: gameObject
 		}))).on(Tweens.Events.TWEEN_COMPLETE, () => {
 			emit("update:tweenchain", void 0);
@@ -415,8 +414,8 @@ const ZoneSetterMap = {
 	...ComputedSizeSetterMap,
 	...DepthSetterMap,
 	...OriginSetterMap,
-	...TransformSetterMap,
 	...ScrollFactorSetterMap,
+	...TransformSetterMap,
 	...VisibleSetterMap,
 	...GlobalSetterMap
 };
@@ -518,6 +517,16 @@ const TintSetterMap = {
 //#endregion
 //#region src/util/setterMap/VideoSetterMap.ts
 const VideoSetterMap = {
+	key: (gameObject) => (value) => {
+		if (!value) return;
+		gameObject.changeSource(value);
+	},
+	muted: (gameObject) => (value) => {
+		gameObject.setMute(value);
+	},
+	volume: (gameObject) => (value) => {
+		gameObject.setVolume(value);
+	},
 	...AlphaSetterMap,
 	...BlendModeSetterMap,
 	...DepthSetterMap,
@@ -530,17 +539,7 @@ const VideoSetterMap = {
 	...TintSetterMap,
 	...TransformSetterMap,
 	...VisibleSetterMap,
-	...GlobalSetterMap,
-	key: (gameObject) => (value) => {
-		if (!value) return;
-		gameObject.changeSource(value);
-	},
-	muted: (gameObject) => (value) => {
-		gameObject.setMute(value);
-	},
-	volume: (gameObject) => (value) => {
-		gameObject.setVolume(value);
-	}
+	...GlobalSetterMap
 };
 //#endregion
 //#region src/components/Video.vue
@@ -813,7 +812,7 @@ const AnimationSetterMap = {
 				emit(event);
 			});
 			if (gameObject.scene.anims.exists(configuration.key)) continue;
-			else if (!gameObject.scene.anims.create(configuration)) throw new InvalidOperationError(Operation.Create, "Animation", configuration.key);
+			if (!gameObject.scene.anims.create(configuration)) throw new InvalidOperationError(Operation.Create, "Animation", configuration.key);
 		}
 	},
 	playAnimationKey: (gameObject) => (value) => {
@@ -929,6 +928,14 @@ const createSceneClass = (key, hooks = {}) => class extends Scene {
 	}
 };
 //#endregion
+//#region src/util/hooks/runSceneShutdown.ts
+const runSceneShutdown = (scene) => {
+	resetLifecycleListeners(scene, "Update");
+	resetLifecycleListeners(scene, "NextTick");
+	runLifecycleListeners(scene, "Shutdown");
+	ExternalSceneStore.sceneReadyMap.set(scene.scene.key, false);
+};
+//#endregion
 //#region src/components/Scene.vue
 const _sfc_main$18 = /*@__PURE__*/ defineComponent({
 	__name: "Scene",
@@ -963,13 +970,16 @@ const _sfc_main$18 = /*@__PURE__*/ defineComponent({
 		const fadeOutCompleteListener = () => {
 			isFading.value = false;
 		};
+		const cameraFadeListeners = [
+			[Cameras.Scene2D.Events.FADE_IN_START, fadeStartListener],
+			[Cameras.Scene2D.Events.FADE_IN_COMPLETE, fadeInCompleteListener],
+			[Cameras.Scene2D.Events.FADE_OUT_START, fadeStartListener],
+			[Cameras.Scene2D.Events.FADE_OUT_COMPLETE, fadeOutCompleteListener]
+		];
 		const NewScene = createSceneClass(__props.sceneKey, {
 			onCreate: (scene) => {
 				emit("create", scene);
-				scene.cameras.main.on(Cameras.Scene2D.Events.FADE_IN_START, fadeStartListener);
-				scene.cameras.main.on(Cameras.Scene2D.Events.FADE_IN_COMPLETE, fadeInCompleteListener);
-				scene.cameras.main.on(Cameras.Scene2D.Events.FADE_OUT_START, fadeStartListener);
-				scene.cameras.main.on(Cameras.Scene2D.Events.FADE_OUT_COMPLETE, fadeOutCompleteListener);
+				for (const [event, listener] of cameraFadeListeners) scene.cameras.main.on(event, listener);
 				isInputActive.value = true;
 			},
 			onInit: (scene) => emit("init", scene),
@@ -981,14 +991,8 @@ const _sfc_main$18 = /*@__PURE__*/ defineComponent({
 		};
 		const shutdownListener = () => {
 			const scene = getScene(__props.sceneKey);
-			resetLifecycleListeners(scene, "Update");
-			resetLifecycleListeners(scene, "NextTick");
-			runLifecycleListeners(scene, "Shutdown");
-			scene.cameras.main.off(Cameras.Scene2D.Events.FADE_IN_START, fadeStartListener);
-			scene.cameras.main.off(Cameras.Scene2D.Events.FADE_IN_COMPLETE, fadeInCompleteListener);
-			scene.cameras.main.off(Cameras.Scene2D.Events.FADE_OUT_START, fadeStartListener);
-			scene.cameras.main.off(Cameras.Scene2D.Events.FADE_OUT_COMPLETE, fadeOutCompleteListener);
-			ExternalSceneStore.sceneReadyMap.set(__props.sceneKey, false);
+			runSceneShutdown(scene);
+			for (const [event, listener] of cameraFadeListeners) scene.cameras.main.off(event, listener);
 			emit("shutdown", scene);
 		};
 		onMounted(async () => {
@@ -1160,6 +1164,10 @@ const _sfc_main$14 = /*@__PURE__*/ defineComponent({
 //#endregion
 //#region src/util/setterMap/ParticlesSetterMap.ts
 const ParticlesSetterMap = {
+	config: (gameObject) => (value) => {
+		if (!value) return;
+		gameObject.setConfig(value);
+	},
 	...AlphaSingleSetterMap,
 	...BlendModeSetterMap,
 	...DepthSetterMap,
@@ -1169,11 +1177,7 @@ const ParticlesSetterMap = {
 	...TextureSetterMap,
 	...TransformSetterMap,
 	...VisibleSetterMap,
-	...GlobalSetterMap,
-	config: (gameObject) => (value) => {
-		if (!value) return;
-		gameObject.setConfig(value);
-	}
+	...GlobalSetterMap
 };
 //#endregion
 //#region src/components/Particles.vue
@@ -1451,6 +1455,7 @@ var TilesetFile = class extends XMLFile {
 const GetFastValue = Utils.Objects.GetFastValue;
 const JSONFile$1 = Loader.FileTypes.JSONFile;
 const MultiFile = Loader.MultiFile;
+const PUBLIC_FOLDER = "public";
 var TiledJSONExternalFile = class extends MultiFile {
 	constructor(loader, key, tilemapURL, path, baseURL, tilemapXhrSettings, tilesetXhrSettings) {
 		if (checkIsPlainObject(key)) {
@@ -1513,7 +1518,7 @@ var TiledJSONExternalFile = class extends MultiFile {
 		loader.setPath(path);
 		loader.setPrefix(prefix);
 		for (const [tilesetIndex, tileset] of tilesets.entries()) {
-			const pathIndex = tileset.source.indexOf("public");
+			const pathIndex = tileset.source.indexOf(PUBLIC_FOLDER);
 			if (pathIndex === -1) throw new NotFoundError(this.onFileComplete.name, tileset.source);
 			const relativePath = tileset.source.slice(pathIndex + 6);
 			const tilesetFile = new TilesetFile(tilesetIndex, loader, `${file.key}${ID_SEPARATOR}Tileset${ID_SEPARATOR}${relativePath}`, relativePath, tilesetXhrSettings);
@@ -1563,11 +1568,11 @@ const _sfc_main$6 = /*@__PURE__*/ defineComponent({
 				...__props.configuration,
 				parent: canvasRoot.value
 			});
-			storeGame.value.events.on("ready", readyListener);
+			storeGame.value.events.on(Core.Events.READY, readyListener);
 		});
 		onUnmounted(() => {
 			const game = useGame();
-			game.events.off("ready", readyListener);
+			game.events.off(Core.Events.READY, readyListener);
 			game.destroy(true);
 			storeGame.value = void 0;
 		});
@@ -1649,8 +1654,8 @@ const ContainerSetterMap = {
 	...AlphaSingleSetterMap,
 	...BlendModeSetterMap,
 	...DepthSetterMap,
-	...ScrollFactorSetterMap,
 	...MaskSetterMap,
+	...ScrollFactorSetterMap,
 	...TransformSetterMap,
 	...VisibleSetterMap,
 	...GlobalSetterMap
@@ -1878,4 +1883,4 @@ const sleepScene = (scene, durationMs) => new Promise((resolve) => {
 const JSONFile = Loader.FileTypes.JSONFile;
 var TilemapFile = class extends JSONFile {};
 //#endregion
-export { AlphaSetterMap, AlphaSingleSetterMap, AnimationSetterMap, _sfc_main as Arc, ArcSetterMap, BaseTextureSetterMap, _sfc_main$1 as BitmapText, BitmapTextSetterMap, BlendModeSetterMap, _sfc_main$2 as Circle, ComputedSizeSetterMap, _sfc_main$3 as Container, ContainerSetterMap, _sfc_main$4 as Curve, CurveSetterMap, DepthSetterMap, DisplaySizeSetterMap, EVENT_PREFIX, _sfc_main$5 as Ellipse, EllipseSetterMap, ExternalSceneStore, FlipSetterMap, _sfc_main$6 as Game, GameObjectEventMap, GameObjectSetterMap, GlobalSetterMap, _sfc_main$7 as Graphics, GraphicsSetterMap, _sfc_main$8 as Image, ImageSetterMap, InjectionKeyMap, _sfc_main$9 as IsoBox, IsoBoxSetterMap, IsoSetterMap, _sfc_main$10 as IsoTriangle, IsoTriangleSetterMap, Lifecycle, _sfc_main$11 as Line, LineSetterMap, MaskSetterMap, _sfc_main$12 as Nineslice, NinesliceSetterMap, OriginSetterMap, _sfc_main$13 as Particles, ParticlesSetterMap, _sfc_main$14 as PathFollower, PathFollowerComponentSetterMap, PathFollowerSetterMap, _sfc_main$15 as Polygon, PolygonSetterMap, _sfc_main$16 as Rectangle, RectangleSetterMap, RenderNodesSetterMap, _sfc_main$17 as RenderTexture, RenderTextureSetterMap, _sfc_main$18 as Scene, ScrollFactorSetterMap, ShapeSetterMap, SizeSetterMap, _sfc_main$19 as Sprite, SpriteSetterMap, _sfc_main$20 as Star, StarSetterMap, TILEMAP_TILED_JSON_EXTERNAL_KEY, _sfc_main$21 as Text, TextSetterMap, TextureCropSetterMap, TextureSetterMap, _sfc_main$22 as TileSprite, TileSpriteSetterMap, TiledJSONExternalFile, _sfc_main$23 as Tilemap, TilemapFile, TilesetFile, TintSetterMap, TransformSetterMap, _sfc_main$24 as Triangle, TriangleSetterMap, TweenSetterMap, _sfc_main$25 as Video, VideoSetterMap, VisibleSetterMap, _sfc_main$26 as Zone, ZoneSetterMap, checkIsEvent, createSceneClass, getDepthInsertIndex, getEventName, getInitializeGameObjectLifecycleHook, getScene, getUpdateEvent, onCreate, onInit, onNextTick, onPreload, onShutdown, onUpdate, pushGameObject, pushListener, registerTiledJSONExternalLoader, resetLifecycleListeners, runLifecycleListeners, sleepScene, useAnimations, useCameraStore, useGame, useInitializeGameObject, useInitializeGameObjectEvents, useInitializeGameObjectSetters, useInjectSceneKey, useInputStore, usePhaserStore, useTextStore, useTween };
+export { AlphaSetterMap, AlphaSingleSetterMap, AnimationSetterMap, _sfc_main as Arc, ArcSetterMap, BaseTextureSetterMap, _sfc_main$1 as BitmapText, BitmapTextSetterMap, BlendModeSetterMap, _sfc_main$2 as Circle, ComputedSizeSetterMap, _sfc_main$3 as Container, ContainerSetterMap, _sfc_main$4 as Curve, CurveSetterMap, DepthSetterMap, DisplaySizeSetterMap, EVENT_PREFIX, _sfc_main$5 as Ellipse, EllipseSetterMap, ExternalSceneStore, FlipSetterMap, _sfc_main$6 as Game, GameObjectEventMap, GameObjectSetterMap, GlobalSetterMap, _sfc_main$7 as Graphics, GraphicsSetterMap, _sfc_main$8 as Image, ImageSetterMap, InjectionKeyMap, _sfc_main$9 as IsoBox, IsoBoxSetterMap, IsoSetterMap, _sfc_main$10 as IsoTriangle, IsoTriangleSetterMap, Lifecycle, _sfc_main$11 as Line, LineSetterMap, MaskSetterMap, _sfc_main$12 as Nineslice, NinesliceSetterMap, OriginSetterMap, _sfc_main$13 as Particles, ParticlesSetterMap, _sfc_main$14 as PathFollower, PathFollowerComponentSetterMap, PathFollowerSetterMap, _sfc_main$15 as Polygon, PolygonSetterMap, _sfc_main$16 as Rectangle, RectangleSetterMap, RenderNodesSetterMap, _sfc_main$17 as RenderTexture, RenderTextureSetterMap, _sfc_main$18 as Scene, ScrollFactorSetterMap, ShapeSetterMap, SizeSetterMap, _sfc_main$19 as Sprite, SpriteSetterMap, _sfc_main$20 as Star, StarSetterMap, TILEMAP_TILED_JSON_EXTERNAL_KEY, _sfc_main$21 as Text, TextSetterMap, TextureCropSetterMap, TextureSetterMap, _sfc_main$22 as TileSprite, TileSpriteSetterMap, TiledJSONExternalFile, _sfc_main$23 as Tilemap, TilemapFile, TilesetFile, TintSetterMap, TransformSetterMap, _sfc_main$24 as Triangle, TriangleSetterMap, TweenSetterMap, _sfc_main$25 as Video, VideoSetterMap, VisibleSetterMap, _sfc_main$26 as Zone, ZoneSetterMap, checkIsEvent, createSceneClass, getDepthInsertIndex, getEventName, getInitializeGameObjectLifecycleHook, getScene, getUpdateEvent, onCreate, onInit, onNextTick, onPreload, onShutdown, onUpdate, pushGameObject, pushListener, registerTiledJSONExternalLoader, resetLifecycleListeners, runLifecycleListeners, runSceneShutdown, sleepScene, useAnimations, useCameraStore, useGame, useInitializeGameObject, useInitializeGameObjectEvents, useInitializeGameObjectSetters, useInjectSceneKey, useInputStore, usePhaserStore, useTextStore, useTween };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-phaserjs",
-  "version": "2.39.0",
+  "version": "3.0.0",
   "description": "A component library to integrate Phaser Framework with Vue.",
   "keywords": [
     "component-library",
@@ -55,18 +55,18 @@
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@esposter/configuration": "2.39.0",
+    "@esposter/configuration": "3.0.0",
     "@vue/test-utils": "^2.5.0",
     "publint": "^0.3.24",
     "tsdown": "^0.23.0",
     "type-fest": "^5.9.0",
     "typedoc": "^0.28.20",
-    "vitest": "^4.1.11",
+    "vitest": "^5.0.0",
     "vue-tsc": "^3.3.11"
   },
   "peerDependencies": {
-    "@esposter/shared": "2.38.1",
-    "parse-tmx": "2.38.1",
+    "@esposter/shared": "2.40.0",
+    "parse-tmx": "2.40.0",
     "phaser": "^4.2.1",
     "phaser4-rex-plugins": "^4.2.0",
     "pinia": "^4.0.3",
@@ -75,5 +75,5 @@
   "inlinedDependencies": {
     "type-fest": "5.9.0"
   },
-  "gitHead": "98f89a176510bb274865731121f990e48c6d056a"
+  "gitHead": "5ea72289bdd594e598aab8fefd5686df2a642a7e"
 }