core2d 2.10.4 → 2.11.2

package/src/Scene.mjs

@@ -4,105 +4,146 @@ import { Engine } from "./Engine.mjs";
 import { Sprite } from "./Sprite.mjs";
 import { Static } from "./Static.mjs";
 
+/**
+ * Represents a scene, which is a collection of sprites that are rendered together.
+ * @extends Sprite
+ */
 export class Scene extends Sprite {
-	constructor() {
-		super();
-		this.height = Engine.height;
-		this.width = Engine.width;
-		this._sprites = [];
-		this._spritesQueue = [];
-	}
-
-	init() {
-		// no default behavior
-	}
-
-	add(sprite) {
-		this._spritesQueue.push(sprite);
-		sprite.scene = this;
-		sprite.init();
-		sprite.x -= sprite.speedX;
-		sprite.y -= sprite.speedY;
-		return this;
-	}
-
-	build(map, tileFactory = null, offsetX = 0, offsetY = 0, x = 0, y = 0) {
-		tileFactory = tileFactory ?? function baseTileFactory(id) {
-			return new Sprite().addTag("tile").setImage(id);
-		};
-
-		for (let i = 0; i < map.length; ++i) {
-			const LINE = map[i];
-
-			for (let j = 0; j < LINE.length; ++j) {
-				const ID = map[i][j];
-
-				if (!ID || "" == ID.trim()) {
-					continue;
-				}
-
-				const TILE = tileFactory(ID);
-
-				if (TILE) {
-					const X = offsetX || TILE.width;
-					const Y = offsetY || TILE.height;
-					TILE.x = x + j * X;
-					TILE.y = y + i * Y;
-					this.add(TILE);
-				}
-			}
-		}
-
-		return this;
-	}
-
-	sync() {
-		Engine.paint(this, this.layerIndex);
-		let sprites = [];
-		const solidSprites = [];
-
-		for (let i = 0; i < this._sprites.length; ++i) {
-			const sprite = this._sprites[i];
-
-			if (sprite.sync()) {
-				if (sprite.essential) {
-					this.setExpired();
-				}
-			} else {
-				if (sprite.solid) {
-					solidSprites.push(sprite);
-				}
-
-				sprites.push(sprite);
-				Engine.paint(sprite, sprite.layerIndex);
-			}
-
-			sprite.collided = false;
-		}
-
-		Static.checkCollisions(solidSprites);
-		this._sprites = sprites.concat(this._spritesQueue);
-		this._spritesQueue = [];
-		return Sprite.prototype.sync.call(this);
-	}
-
-	getObjectsWithTag(tag) {
-		const RESULT = [];
-		const SPRITES = this._sprites.concat(this._spritesQueue);
-
-		for (let i = 0; i < SPRITES.length; ++i) {
-			const SPRITE = SPRITES[i];
-
-			if (SPRITE.hasTag(tag)) {
-				RESULT.push(SPRITE);
-			}
-		}
-
-		return RESULT;
-	}
-
-	setTransition(transition) {
-		this.transition = transition;
-		return this;
-	}
+  /**
+   * Creates a new Scene.
+   */
+  constructor() {
+    super();
+    this.height = Engine.height;
+    this.width = Engine.width;
+    this._sprites = [];
+    this._spritesQueue = [];
+  }
+
+  /**
+   * Initializes the scene.
+   */
+  init() {
+    // no default behavior
+  }
+
+  /**
+   * Adds a sprite to the scene.
+   * @param {Sprite} sprite The sprite to add.
+   * @returns {Scene} This scene.
+   */
+  add(sprite) {
+    this._spritesQueue.push(sprite);
+    sprite.scene = this;
+    sprite.init();
+    sprite.x -= sprite.speedX;
+    sprite.y -= sprite.speedY;
+    return this;
+  }
+
+  /**
+   * Builds a tilemap from a map.
+   * @param {string[][]} map The map.
+   * @param {function(string): Sprite} [tileFactory=null] A function that creates a tile from an ID.
+   * @param {number} [offsetX=0] The horizontal offset between tiles.
+   * @param {number} [offsetY=0] The vertical offset between tiles.
+   * @param {number} [x=0] The horizontal position of the tilemap.
+   * @param {number} [y=0] The vertical position of the tilemap.
+   * @returns {Scene} This scene.
+   */
+  build(map, tileFactory = null, offsetX = 0, offsetY = 0, x = 0, y = 0) {
+    tileFactory =
+      tileFactory ??
+      function baseTileFactory(id) {
+        return new Sprite().addTag("tile").setImage(id);
+      };
+
+    for (let i = 0; i < map.length; ++i) {
+      const LINE = map[i];
+
+      for (let j = 0; j < LINE.length; ++j) {
+        const ID = map[i][j];
+
+        if (!ID || "" == ID.trim()) {
+          continue;
+        }
+
+        const TILE = tileFactory(ID);
+
+        if (TILE) {
+          const X = offsetX || TILE.width;
+          const Y = offsetY || TILE.height;
+          TILE.x = x + j * X;
+          TILE.y = y + i * Y;
+          this.add(TILE);
+        }
+      }
+    }
+
+    return this;
+  }
+
+  /**
+   * Synchronizes the scene.
+   * @returns {boolean} Whether the scene has expired.
+   */
+  sync() {
+    Engine.paint(this, this.layerIndex);
+    let sprites = [];
+    const solidSprites = [];
+
+    for (let i = 0; i < this._sprites.length; ++i) {
+      const sprite = this._sprites[i];
+
+      if (sprite.sync()) {
+        if (sprite.essential) {
+          this.setExpired();
+        }
+      } else {
+        if (sprite.solid) {
+          solidSprites.push(sprite);
+        }
+
+        sprites.push(sprite);
+        Engine.paint(sprite, sprite.layerIndex);
+      }
+
+      sprite.collided = false;
+    }
+
+    Static.checkCollisions(solidSprites);
+    this._sprites = sprites.concat(this._spritesQueue);
+    this._spritesQueue = [];
+    return Sprite.prototype.sync.call(this);
+  }
+
+  /**
+   * Gets all sprites with a specific tag.
+   * @param {string} tag The tag.
+   * @returns {Sprite[]} The sprites with the tag.
+   */
+  getObjectsWithTag(tag) {
+    const RESULT = [];
+    const SPRITES = this._sprites.concat(this._spritesQueue);
+
+    for (let i = 0; i < SPRITES.length; ++i) {
+      const SPRITE = SPRITES[i];
+
+      if (SPRITE.hasTag(tag)) {
+        RESULT.push(SPRITE);
+      }
+    }
+
+    return RESULT;
+  }
+
+  /**
+   * Sets the transition to the next scene.
+   * @param {Transition} transition The transition.
+   * @returns {Scene} This scene.
+   */
+  setTransition(transition) {
+    this.transition = transition;
+    return this;
+  }
 }

package/src/Sound.mjs

@@ -5,134 +5,138 @@ import { Static } from "./Static.mjs";
 const DEFAULT_PLAY_VOLUME = 0.3;
 
 export class Sound {
-	constructor() {
-		this._isFading = false;
-		this._isMute = false;
-		this._nextThemeName = null;
-		this._queue = {};
-		this._theme = null;
-		this._themeId = null;
-		this._volume = 100;
-	}
-
-	fadeOut() {
-		if (!this._theme) {
-			return;
-		}
-
-		this._isFading = true;
-		this._volume = 100;
-	}
-
-	mute() {
-		this._isMute = !this._isMute;
-
-		if (!this._isMute) {
-			this._theme.play();
-		} else {
-			this._theme.pause();
-		}
-	}
-
-	pause() {
-		if (this._theme) {
-			this._theme.pause();
-		}
-	}
-
-	play(id, volume = DEFAULT_PLAY_VOLUME) {
-		if (this._isMute) {
-			return;
-		}
-
-		this._queue[id] = volume;
-	}
-
-	playTheme(id) {
-		if (id == this._themeId) {
-			return;
-		}
-
-		if (this._theme && this._theme.currentTime > 0) {
-			this._nextThemeName = id;
-
-			if (!this._isFading) {
-				this.fadeOut();
-			}
-
-			return;
-		}
-
-		this.stopTheme();
-		this._theme = Static.getElement(id);
-		this._themeId = id;
-
-		if (this._theme.currentTime > 0) {
-			this._theme.currentTime = 0;
-		}
-
-		if (this._isMute) {
-			return;
-		}
-
-		this._theme.volume = 1;
-		this._theme.play();
-	}
-
-	resume() {
-		if (this._isMute) {
-			return;
-		}
-
-		if (this._theme.paused) {
-			this._theme.play();
-		}
-	}
-
-	stopTheme() {
-		this._isFading = false;
-
-		if (this._theme) {
-			this._theme.pause();
-			this._theme.currentTime = 0;
-			this._themeId = null;
-		}
-	}
-
-	update() {
-		for (let id in this._queue) {
-			const SOUND = Static.getElement(id);
-
-			if (!SOUND?.pause) {
-				console.warn(`Could not find audio with id: ${id}`);
-			}
-
-			SOUND.pause();
-
-			if (SOUND.currentTime > 0) {
-				SOUND.currentTime = 0;
-			}
-
-			SOUND.volume = this._queue[id];
-			SOUND.play();
-		}
-
-		this._queue = {};
-
-		if (this._isFading) {
-			if (--this._volume > 0) {
-				this._theme.volume = this._volume / 100;
-			} else {
-				this.stopTheme();
-				this._isFading = false;
-				this._theme = null;
-
-				if (this._nextThemeName) {
-					this.playTheme(this._nextThemeName);
-					this._themeId = this._nextThemeName;
-					this._nextThemeName = null;
-				}
-			}
-		}
-	}
+  constructor() {
+    this._isFading = false;
+    this._isMute = false;
+    this._nextThemeName = null;
+    this._queue = {};
+    this._theme = null;
+    this._themeId = null;
+    this._volume = 100;
+  }
+
+  fadeOut() {
+    if (!this._theme) {
+      return;
+    }
+
+    this._isFading = true;
+    this._volume = 100;
+  }
+
+  mute() {
+    this._isMute = !this._isMute;
+
+    if (!this._theme) {
+      return;
+    }
+
+    if (!this._isMute) {
+      this._theme.play();
+    } else {
+      this._theme.pause();
+    }
+  }
+
+  pause() {
+    if (this._theme) {
+      this._theme.pause();
+    }
+  }
+
+  play(id, volume = DEFAULT_PLAY_VOLUME) {
+    if (this._isMute) {
+      return;
+    }
+
+    this._queue[id] = volume;
+  }
+
+  playTheme(id) {
+    if (id == this._themeId) {
+      return;
+    }
+
+    if (this._theme && this._theme.currentTime > 0) {
+      this._nextThemeName = id;
+
+      if (!this._isFading) {
+        this.fadeOut();
+      }
+
+      return;
+    }
+
+    this.stopTheme();
+    this._theme = Static.getElement(id);
+    this._themeId = id;
+
+    if (this._theme.currentTime > 0) {
+      this._theme.currentTime = 0;
+    }
+
+    if (this._isMute) {
+      return;
+    }
+
+    this._theme.volume = 1;
+    this._theme.play();
+  }
+
+  resume() {
+    if (this._isMute) {
+      return;
+    }
+
+    if (this._theme.paused) {
+      this._theme.play();
+    }
+  }
+
+  stopTheme() {
+    this._isFading = false;
+
+    if (this._theme) {
+      this._theme.pause();
+      this._theme.currentTime = 0;
+      this._themeId = null;
+    }
+  }
+
+  update() {
+    for (let id in this._queue) {
+      const SOUND = Static.getElement(id);
+
+      if (!SOUND?.pause) {
+        console.warn(`Could not find audio with id: ${id}`);
+      }
+
+      SOUND.pause();
+
+      if (SOUND.currentTime > 0) {
+        SOUND.currentTime = 0;
+      }
+
+      SOUND.volume = this._queue[id];
+      SOUND.play();
+    }
+
+    this._queue = {};
+
+    if (this._isFading) {
+      if (--this._volume > 0) {
+        this._theme.volume = this._volume / 100;
+      } else {
+        this.stopTheme();
+        this._isFading = false;
+        this._theme = null;
+
+        if (this._nextThemeName) {
+          this.playTheme(this._nextThemeName);
+          this._themeId = this._nextThemeName;
+          this._nextThemeName = null;
+        }
+      }
+    }
+  }
 }