core2d 2.10.3 → 2.11.1

package/src/Engine.mjs

@@ -29,13 +29,11 @@ export const Engine = (() => {
 		},
 	};
 
-	const RENDER_STRATEGIES = [
-		RENDER_STRATEGY.DEFAULT,
-		RENDER_STRATEGY.DEGRADED,
-	];
+	const RENDER_STRATEGIES = [RENDER_STRATEGY.DEFAULT, RENDER_STRATEGY.DEGRADED];
 
 	let _autoScale = true;
-	let _canvas = Static.getElement("app") || Static.getElements(CANVAS_ELEMENT)[0];
+	let _canvas =
+		Static.getElement("app") || Static.getElements(CANVAS_ELEMENT)[0];
 	let _context = _canvas.getContext(CONTEXT);
 	let _degraded = 0;
 	let _everyOther = true;
@@ -126,7 +124,11 @@ export const Engine = (() => {
 			_context.clearRect(0, 0, _width, _height);
 		}
 
-		static colorize(image, fillStyle, compositeOperation = CompositeOperations.SOURCE_IN) {
+		static colorize(
+			image,
+			fillStyle,
+			compositeOperation = CompositeOperations.SOURCE_IN
+		) {
 			const input = Static.getImage(image);
 			const output = ACL.document.createElement(CANVAS_ELEMENT);
 			output.width = input.width;
@@ -210,7 +212,7 @@ export const Engine = (() => {
 			const input = Static.getImage(image);
 			degrees = degrees % 360;
 
-			if (degrees == 0 ) {
+			if (degrees == 0) {
 				return input;
 			}
 
@@ -226,7 +228,8 @@ export const Engine = (() => {
 
 		static save(data, namespace) {
 			try {
-				localStorage[namespace || Engine.getName()] = data && JSON.stringify(data);
+				localStorage[namespace || Engine.getName()] =
+					data && JSON.stringify(data);
 			} catch (error) {
 				console.log("Could not save current game: " + error);
 			}
@@ -339,7 +342,7 @@ export const Engine = (() => {
 		}
 
 		context.fillStyle = Color.Blue;
-		context.fillRect(0, 0, canvas.width * complete / total, canvas.height);
+		context.fillRect(0, 0, (canvas.width * complete) / total, canvas.height);
 
 		if (complete < total) {
 			setTimeout(() => {
@@ -382,7 +385,7 @@ export const Engine = (() => {
 		output.height = input.height;
 		const context = output.getContext(CONTEXT);
 		context.translate(isMirror ? output.width : 0, isFlip ? output.height : 0);
-		context.scale(isMirror ? -1 : 1, isFlip ? - 1 : 1);
+		context.scale(isMirror ? -1 : 1, isFlip ? -1 : 1);
 		context.drawImage(input, 0, 0);
 		return output;
 	}

package/src/Frame.mjs

@@ -2,24 +2,48 @@
 
 import { Static } from "./Static.mjs";
 
+/**
+ * Represents a frame in an animation.
+ */
 export class Frame {
+	/**
+	 * Creates a new Frame.
+	 * @param {HTMLImageElement|HTMLCanvasElement} image The image of the frame.
+	 * @param {number} [duration=0] The duration of the frame in ticks.
+	 */
 	constructor(image, duration = 0) {
 		this._image = Static.getImage(image);
 		this._duration = duration;
 	}
 
+	/**
+	 * The image of the frame.
+	 * @type {HTMLImageElement|HTMLCanvasElement}
+	 */
 	get image() {
 		return this._image;
 	}
 
+	/**
+	 * The duration of the frame in ticks.
+	 * @type {number}
+	 */
 	get duration() {
 		return this._duration;
 	}
 
+	/**
+	 * The width of the frame.
+	 * @type {number}
+	 */
 	get width() {
 		return this._image.width;
 	}
 
+	/**
+	 * The height of the frame.
+	 * @type {number}
+	 */
 	get height() {
 		return this._image.height;
 	}

package/src/GamePad.mjs

@@ -25,15 +25,19 @@ export class GamePad {
 		const BUTTONS = Input.getGamePadButtons(this._id);
 		const RESULT = {};
 
-		if (Input.getGamePadAxes(this._id)[Axis.LEFT_Y] < - this.analogThreshold) {
+		if (Input.getGamePadAxes(this._id)[Axis.LEFT_Y] < -this.analogThreshold) {
 			RESULT[Command.UP] = true;
-		} else if (Input.getGamePadAxes(this._id)[Axis.LEFT_Y] > this.analogThreshold) {
+		} else if (
+			Input.getGamePadAxes(this._id)[Axis.LEFT_Y] > this.analogThreshold
+		) {
 			RESULT[Command.DOWN] = true;
 		}
 
-		if (Input.getGamePadAxes(this._id)[Axis.LEFT_X] < - this.analogThreshold) {
+		if (Input.getGamePadAxes(this._id)[Axis.LEFT_X] < -this.analogThreshold) {
 			RESULT[Command.LEFT] = true;
-		} else if (Input.getGamePadAxes(this._id)[Axis.LEFT_X] > this.analogThreshold) {
+		} else if (
+			Input.getGamePadAxes(this._id)[Axis.LEFT_X] > this.analogThreshold
+		) {
 			RESULT[Command.RIGHT] = true;
 		}
 

package/src/Input.mjs

@@ -51,7 +51,7 @@ export class Input {
 
 	static getGamePadButtons(id) {
 		const GAMEPAD = Static.getGamepads()[id];
-		return GAMEPAD && GAMEPAD.buttons || [];
+		return (GAMEPAD && GAMEPAD.buttons) || [];
 	}
 
 	addController(device) {
@@ -72,7 +72,10 @@ export class Input {
 	}
 
 	checkControllerQueues() {
-		if (this._controllerRequestQueue.length > 0 && this._controllerQueue.length > 0) {
+		if (
+			this._controllerRequestQueue.length > 0 &&
+			this._controllerQueue.length > 0
+		) {
 			const REQUESTER = this._controllerRequestQueue.shift();
 			const DEVICE = this._controllerQueue.shift();
 			REQUESTER.setDevice(DEVICE);

package/src/Key.mjs

@@ -18,5 +18,5 @@ export const Key = {
 	J: 74,
 	K: 75,
 	L: 76,
-	S: 83
+	S: 83,
 };

package/src/Keyboard.mjs

@@ -7,8 +7,8 @@ export class Keyboard {
 		this._buffer = {};
 
 		this.onKey(event, true);
-		addEventListener("keydown", event => this.onKey(event, true), false);
-		addEventListener("keyup", event => this.onKey(event, false), false);
+		addEventListener("keydown", (event) => this.onKey(event, true), false);
+		addEventListener("keyup", (event) => this.onKey(event, false), false);
 	}
 
 	get commands() {
@@ -27,7 +27,7 @@ export class Keyboard {
 		const COMMAND = KeyMap[event.keyCode];
 		this._buffer[COMMAND] = isDown;
 
-		if (isDown && "number" == typeof(COMMAND)) {
+		if (isDown && "number" == typeof COMMAND) {
 			event.preventDefault();
 		}
 	}

package/src/Mouse.mjs

@@ -7,19 +7,31 @@ export class Mouse extends Point {
 		super();
 		this.updateCoordinates(event);
 
-		addEventListener("mousedown", (event) => {
-			event.preventDefault();
-			this._isDown = true;
-		}, false);
+		addEventListener(
+			"mousedown",
+			(event) => {
+				event.preventDefault();
+				this._isDown = true;
+			},
+			false
+		);
 
-		addEventListener("mousemove", (event) => {
-			this.updateCoordinates(event);
-		}, false);
+		addEventListener(
+			"mousemove",
+			(event) => {
+				this.updateCoordinates(event);
+			},
+			false
+		);
 
-		addEventListener("mouseup", (event) => {
-			event.preventDefault();
-			this._isDown = false;
-		}, false);
+		addEventListener(
+			"mouseup",
+			(event) => {
+				event.preventDefault();
+				this._isDown = false;
+			},
+			false
+		);
 	}
 
 	get command() {

package/src/Point.mjs

@@ -1,35 +1,71 @@
 "use strict";
 
+/**
+ * Represents a point with x and y coordinates.
+ */
 export class Point {
+	/**
+	 * Creates a new Point.
+	 * @param {number} [x=0] The x-coordinate.
+	 * @param {number} [y=0] The y-coordinate.
+	 */
 	constructor(x = 0, y = 0) {
 		this.x = x;
 		this.y = y;
 	}
 
+	/**
+	 * The position of the point.
+	 * @type {Point}
+	 */
 	get position() {
 		return this;
 	}
 
+	/**
+	 * Sets the x-coordinate of the point.
+	 * @param {number} x The x-coordinate.
+	 * @returns {Point} This point.
+	 */
 	setX(x) {
 		this.x = x;
 		return this;
 	}
 
+	/**
+	 * Sets the y-coordinate of the point.
+	 * @param {number} y The y-coordinate.
+	 * @returns {Point} This point.
+	 */
 	setY(y) {
 		this.y = y;
 		return this;
 	}
 
+	/**
+	 * Sets the position of the point.
+	 * @param {Point} point The new position.
+	 * @returns {Point} This point.
+	 */
 	setPosition(point) {
 		this.x = point.x;
 		this.y = point.y;
 		return this;
 	}
 
+	/**
+	 * The position of the point.
+	 * @type {Point}
+	 */
 	set position(point) {
 		this.setPosition(point);
 	}
 
+	/**
+	 * Calculates the distance to another point.
+	 * @param {Point} point The other point.
+	 * @returns {number} The distance to the other point.
+	 */
 	distance(point) {
 		const dx = point.x - this.x;
 		const dy = point.y - this.y;

package/src/Pointer.mjs

@@ -3,7 +3,14 @@
 import { Engine } from "./Engine.mjs";
 import { Point } from "./Point.mjs";
 
+/**
+ * Represents a pointer, which can be a mouse or a touch.
+ * @extends Point
+ */
 export class Pointer extends Point {
+	/**
+	 * Creates a new Pointer.
+	 */
 	constructor() {
 		super();
 		this._active = false;
@@ -11,18 +18,33 @@ export class Pointer extends Point {
 		this._hold = false;
 	}
 
+	/**
+	 * Whether the pointer is down.
+	 * @type {boolean}
+	 */
 	get down() {
 		return this._active;
 	}
 
+	/**
+	 * Whether the pointer was just pushed.
+	 * @type {boolean}
+	 */
 	get push() {
 		return this._active && !this._hold;
 	}
 
+	/**
+	 * Sets the device of the pointer.
+	 * @param {object} device The device.
+	 */
 	setDevice(device) {
 		this._device = device;
 	}
 
+	/**
+	 * Updates the pointer.
+	 */
 	update() {
 		if (!this._device) {
 			return;
@@ -38,7 +60,7 @@ export class Pointer extends Point {
 
 		const REAL_X = this._device.x - Engine.offsetLeft;
 		const REAL_Y = this._device.y - Engine.offsetTop;
-		this.x = Math.floor(REAL_X * Engine.width / Engine.realWidth);
-		this.y = Math.floor(REAL_Y * Engine.height / Engine.realHeight);
+		this.x = Math.floor((REAL_X * Engine.width) / Engine.realWidth);
+		this.y = Math.floor((REAL_Y * Engine.height) / Engine.realHeight);
 	}
 }

package/src/Rect.mjs

@@ -2,126 +2,248 @@
 
 import { Point } from "./Point.mjs";
 
+/**
+ * Represents a rectangle.
+ * @extends Point
+ */
 export class Rect extends Point {
+	/**
+	 * Creates a new Rect.
+	 * @param {number} x The x-coordinate of the rectangle.
+	 * @param {number} y The y-coordinate of the rectangle.
+	 * @param {number} [width=0] The width of the rectangle.
+	 * @param {number} [height=0] The height of the rectangle.
+	 */
 	constructor(x, y, width = 0, height = 0) {
 		super(x, y);
 		this.width = width;
 		this.height = height;
 	}
 
+	/**
+	 * The x-coordinate of the left edge of the rectangle.
+	 * @type {number}
+	 */
 	get left() {
 		return this.x;
 	}
 
+	/**
+	 * The x-coordinate of the right edge of the rectangle.
+	 * @type {number}
+	 */
 	get right() {
 		return this.x + this.width - 1;
 	}
 
+	/**
+	 * The y-coordinate of the top edge of the rectangle.
+	 * @type {number}
+	 */
 	get top() {
 		return this.y;
 	}
 
+	/**
+	 * The y-coordinate of the bottom edge of the rectangle.
+	 * @type {number}
+	 */
 	get bottom() {
 		return this.y + this.height - 1;
 	}
 
+	/**
+	 * The x-coordinate of the center of the rectangle.
+	 * @type {number}
+	 */
 	get centerX() {
 		return this.x + Math.floor(this.width / 2);
 	}
 
+	/**
+	 * The y-coordinate of the center of the rectangle.
+	 * @type {number}
+	 */
 	get centerY() {
 		return this.y + Math.floor(this.height / 2);
 	}
 
+	/**
+	 * The center of the rectangle.
+	 * @type {Point}
+	 */
 	get center() {
 		return new Point(this.centerX, this.centerY);
 	}
 
+	/**
+	 * Sets the width of the rectangle.
+	 * @param {number} width The new width.
+	 * @returns {Rect} This rectangle.
+	 */
 	setWidth(width) {
 		this.width = width;
 		return this;
 	}
 
+	/**
+	 * Sets the height of the rectangle.
+	 * @param {number} height The new height.
+	 * @returns {Rect} This rectangle.
+	 */
 	setHeight(height) {
 		this.height = height;
 		return this;
 	}
 
+	/**
+	 * Sets the size of the rectangle.
+	 * @param {Rect} rect The new size.
+	 * @returns {Rect} This rectangle.
+	 */
 	setSize(rect) {
 		this.setWidth(rect.width);
 		this.setHeight(rect.height);
 		return this;
 	}
 
+	/**
+	 * Sets the x-coordinate of the left edge of the rectangle.
+	 * @param {number} x The new x-coordinate.
+	 * @returns {Rect} This rectangle.
+	 */
 	setLeft(x) {
 		this.x = x;
 		return this;
 	}
 
+	/**
+	 * Sets the x-coordinate of the right edge of the rectangle.
+	 * @param {number} x The new x-coordinate.
+	 * @returns {Rect} This rectangle.
+	 */
 	setRight(x) {
 		this.x = x - this.width + 1;
 		return this;
 	}
 
+	/**
+	 * Sets the y-coordinate of the top edge of the rectangle.
+	 * @param {number} y The new y-coordinate.
+	 * @returns {Rect} This rectangle.
+	 */
 	setTop(y) {
 		this.y = y;
 		return this;
 	}
 
+	/**
+	 * Sets the y-coordinate of the bottom edge of the rectangle.
+	 * @param {number} y The new y-coordinate.
+	 * @returns {Rect} This rectangle.
+	 */
 	setBottom(y) {
 		this.y = y - this.height + 1;
 		return this;
 	}
 
+	/**
+	 * Sets the x-coordinate of the center of the rectangle.
+	 * @param {number} x The new x-coordinate.
+	 * @returns {Rect} This rectangle.
+	 */
 	setCenterX(x) {
 		this.x = x - Math.floor(this.width / 2);
 		return this;
 	}
 
+	/**
+	 * Sets the y-coordinate of the center of the rectangle.
+	 * @param {number} y The new y-coordinate.
+	 * @returns {Rect} This rectangle.
+	 */
 	setCenterY(y) {
 		this.y = y - Math.floor(this.height / 2);
 		return this;
 	}
 
+	/**
+	 * Sets the center of the rectangle.
+	 * @param {Point} point The new center.
+	 * @returns {Rect} This rectangle.
+	 */
 	setCenter(point) {
 		this.setCenterX(point.x);
 		this.setCenterY(point.y);
 		return this;
 	}
 
+	/**
+	 * The x-coordinate of the left edge of the rectangle.
+	 * @type {number}
+	 */
 	set left(x) {
 		this.setLeft(x);
 	}
 
+	/**
+	 * The x-coordinate of the right edge of the rectangle.
+	 * @type {number}
+	 */
 	set right(x) {
 		this.setRight(x);
 	}
 
+	/**
+	 * The y-coordinate of the top edge of the rectangle.
+	 * @type {number}
+	 */
 	set top(y) {
 		this.setTop(y);
 	}
 
+	/**
+	 * The y-coordinate of the bottom edge of the rectangle.
+	 * @type {number}
+	 */
 	set bottom(y) {
 		this.setBottom(y);
 	}
 
+	/**
+	 * The x-coordinate of the center of the rectangle.
+	 * @type {number}
+	 */
 	set centerX(x) {
 		this.setCenterX(x);
 	}
 
+	/**
+	 * The y-coordinate of the center of the rectangle.
+	 * @type {number}
+	 */
 	set centerY(y) {
 		this.setCenterY(y);
 	}
 
+	/**
+	 * The center of the rectangle.
+	 * @type {Point}
+	 */
 	set center(point) {
 		this.setCenter(point);
 	}
 
+	/**
+	 * Creates a new rectangle that is the union of this rectangle and another rectangle.
+	 * @param {Rect} rect The other rectangle.
+	 * @returns {Rect} The new rectangle.
+	 */
 	makeUnion(rect) {
 		const RECT = new Rect(Math.min(this.x, rect.x), Math.min(this.y, rect.y));
 
-		return RECT
-			.setWidth(Math.max(this.right, rect.right) - RECT.x + 1)
-			.setHeight(Math.max(this.bottom, rect.bottom) - RECT.y + 1);
+		return RECT.setWidth(
+			Math.max(this.right, rect.right) - RECT.x + 1
+		).setHeight(Math.max(this.bottom, rect.bottom) - RECT.y + 1);
 	}
 }

package/src/Scene.mjs

@@ -4,7 +4,14 @@ 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 {
+	/**
+	 * Creates a new Scene.
+	 */
 	constructor() {
 		super();
 		this.height = Engine.height;
@@ -13,10 +20,18 @@ export class Scene extends Sprite {
 		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;
@@ -26,10 +41,22 @@ export class Scene extends Sprite {
 		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);
-		};
+		tileFactory =
+			tileFactory ??
+			function baseTileFactory(id) {
+				return new Sprite().addTag("tile").setImage(id);
+			};
 
 		for (let i = 0; i < map.length; ++i) {
 			const LINE = map[i];
@@ -56,6 +83,10 @@ export class Scene extends Sprite {
 		return this;
 	}
 
+	/**
+	 * Synchronizes the scene.
+	 * @returns {boolean} Whether the scene has expired.
+	 */
 	sync() {
 		Engine.paint(this, this.layerIndex);
 		let sprites = [];
@@ -86,6 +117,11 @@ export class Scene extends Sprite {
 		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);
@@ -101,6 +137,11 @@ export class Scene extends 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;