@vpmedia/phaser 1.94.0 → 1.96.0

package/src/phaser/core/device_util.js

@@ -4,18 +4,18 @@ import { Device } from './device.js';
 const logger = new Logger('device');
 
 /**
- * TBD.
- * @param {Device} device - TBD.
- * @param {string} type - TBD.
- * @returns {boolean} TBD.
+ * Check if the device can play a specific audio format.
+ * @param {Device} device - The device instance to check.
+ * @param {string} type - The audio format type to check.
+ * @returns {boolean} True if the device can play this audio format, false otherwise.
  */
 export const canPlayAudio = (device, type) => {
   return device.supportedAudioFormats[type] === true;
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Detect the operating system of the device.
+ * @param {Device} device - The device instance to update.
  */
 export const checkOS = (device) => {
   const ua = navigator.userAgent;
@@ -51,8 +51,8 @@ export const checkOS = (device) => {
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Detect input capabilities of the device.
+ * @param {Device} device - The device instance to update.
  */
 export const checkInput = (device) => {
   if (
@@ -71,8 +71,8 @@ export const checkInput = (device) => {
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Check for fullscreen support capabilities.
+ * @param {Device} device - The device instance to update.
  */
 export const checkFullScreenSupport = (device) => {
   const fs = [
@@ -118,8 +118,8 @@ export const checkFullScreenSupport = (device) => {
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Detect the browser type.
+ * @param {Device} device - The device instance to update.
  */
 export const checkBrowser = (device) => {
   const ua = navigator.userAgent;
@@ -135,10 +135,10 @@ export const checkBrowser = (device) => {
 };
 
 /**
- * Check for codec support.
- * @param {HTMLAudioElement} audioElement - TBD.
- * @param {string} type - TBD.
- * @returns {boolean} TBD.
+ * Check if an audio element can play a specific codec.
+ * @param {HTMLAudioElement} audioElement - The audio element to test.
+ * @param {string} type - The codec type to check.
+ * @returns {boolean} True if the codec is supported, false otherwise.
  */
 export const canPlayType = (audioElement, type) => {
   try {
@@ -152,9 +152,9 @@ export const canPlayType = (audioElement, type) => {
 };
 
 /**
- * Check for codec support.
- * @param {string} type - TBD.
- * @returns {boolean} TBD.
+ * Check if a media source type is supported by the browser.
+ * @param {string} type - The media source type to check.
+ * @returns {boolean} True if the media source type is supported, false otherwise.
  */
 export const isMediaSourceTypeSupported = (type) => {
   if ('MediaSource' in window) {
@@ -170,8 +170,8 @@ export const isMediaSourceTypeSupported = (type) => {
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Check for supported audio formats on the device.
+ * @param {Device} device - The device instance to update with audio format support.
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
  * @see https://developer.mozilla.org/En/Media_formats_supported_by_the_audio_and_video_elements
  * @see https://bit.ly/iphoneoscodecs
@@ -205,8 +205,8 @@ export const checkAudio = (device) => {
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Check for supported image formats on the device.
+ * @param {Device} device - The device instance to update with image format support.
  */
 export const checkImage = (device) => {
   try {
@@ -233,8 +233,8 @@ export const checkImage = (device) => {
 };
 
 /**
- * TBD.
- * @param {Device} device - TBD.
+ * Initialize device capabilities detection.
+ * @param {Device} device - The device instance to initialize.
  */
 export const initialize = (device) => {
   logger.info('initialize');
@@ -247,8 +247,8 @@ export const initialize = (device) => {
 };
 
 /**
- * TBD.
- * @returns {Device} TBD.
+ * Create a new Device instance.
+ * @returns {Device} A new Device instance.
  */
 export const createDevice = () => {
   return new Device();

package/src/phaser/core/dom.js

@@ -2,32 +2,32 @@ import { Point } from '../geom/point.js';
 
 class VisualBoundsDesktopRectangle {
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the horizontal scroll position of the window.
+   * @returns {number} The horizontal scroll position in pixels.
    */
   get x() {
     return window && 'pageXOffset' in window ? window.pageXOffset : document.documentElement.scrollLeft;
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the vertical scroll position of the window.
+   * @returns {number} The vertical scroll position in pixels.
    */
   get y() {
     return window && 'pageYOffset' in window ? window.pageYOffset : document.documentElement.scrollTop;
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the width of the window.
+   * @returns {number} The width of the window in pixels.
    */
   get width() {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the height of the window.
+   * @returns {number} The height of the window in pixels.
    */
   get height() {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
@@ -36,32 +36,32 @@ class VisualBoundsDesktopRectangle {
 
 class LayoutBoundsDesktopRectangle {
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the horizontal scroll position of the window.
+   * @returns {number} The horizontal scroll position in pixels.
    */
   get x() {
     return 0;
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the vertical scroll position of the window.
+   * @returns {number} The vertical scroll position in pixels.
    */
   get y() {
     return 0;
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the width of the window.
+   * @returns {number} The width of the window in pixels.
    */
   get width() {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the height of the window.
+   * @returns {number} The height of the window in pixels.
    */
   get height() {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
@@ -70,16 +70,16 @@ class LayoutBoundsDesktopRectangle {
 
 class VisualBoundsRectangle {
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the horizontal scroll position of the document.
+   * @returns {number} The horizontal scroll position in pixels.
    */
   get x() {
     return window && 'pageXOffset' in window ? window.pageXOffset : document.documentElement.scrollLeft;
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the vertical scroll position of the document.
+   * @returns {number} The vertical scroll position in pixels.
    */
   get y() {
     return window && 'pageYOffset' in window ? window.pageYOffset : document.documentElement.scrollTop;
@@ -199,10 +199,10 @@ export class DOM {
   }
 
   /**
-   * TBD.
-   * @param {HTMLCanvasElement} element - TBD.
-   * @param {Point} point - TBD.
-   * @returns {Point} TBD.
+   * Gets the offset position of an element relative to the document.
+   * @param {HTMLCanvasElement} element - The element to get the offset for.
+   * @param {Point} point - Optional Point object to store the result.
+   * @returns {Point} The offset position of the element.
    */
   getOffset(element, point = null) {
     point = point || new Point();
@@ -217,10 +217,10 @@ export class DOM {
   }
 
   /**
-   * TBD.
-   * @param {HTMLCanvasElement} element - TBD.
-   * @param {number} cushion - TBD.
-   * @returns {boolean} TBD.
+   * Gets the bounding rectangle of an element with optional cushion.
+   * @param {HTMLCanvasElement} element - The element to get bounds for.
+   * @param {number} cushion - Optional padding to add around the element.
+   * @returns {boolean} True if bounds were successfully retrieved, false otherwise.
    */
   getBounds(element, cushion = 0) {
     element = element && !element.nodeType ? element[0] : element;
@@ -231,10 +231,10 @@ export class DOM {
   }
 
   /**
-   * TBD.
-   * @param {DOMRect} coords - TBD.
-   * @param {number} cushion - TBD.
-   * @returns {object} TBD.
+   * Calibrates DOM rectangle coordinates with optional cushion.
+   * @param {DOMRect} coords - The DOM rectangle coordinates to calibrate.
+   * @param {number} cushion - Optional padding to add around the rectangle.
+   * @returns {{width: number, height: number, left: number, right: number, top: number, bottom: number}} The calibrated rectangle.
    */
   calibrate(coords, cushion = 0) {
     const output = {
@@ -251,9 +251,9 @@ export class DOM {
   }
 
   /**
-   * TBD.
-   * @param {string} primaryFallback - TBD.
-   * @returns {string} TBD.
+   * Gets the screen orientation.
+   * @param {string} primaryFallback - The fallback method to use if screen orientation API is not available.
+   * @returns {string} The screen orientation ('portrait-primary', 'landscape-primary', etc.).
    */
   getScreenOrientation(primaryFallback) {
     const screen = window.screen;
@@ -286,32 +286,32 @@ export class DOM {
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the horizontal scroll position of the window.
+   * @returns {number} The horizontal scroll position in pixels.
    */
   get scrollX() {
     return this.scrollXProvider();
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the vertical scroll position of the window.
+   * @returns {number} The vertical scroll position in pixels.
    */
   get scrollY() {
     return this.scrollYProvider();
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the width of the window's client area.
+   * @returns {number} The width of the client area in pixels.
    */
   get clientWidth() {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
   /**
-   * TBD.
-   * @returns {number} TBD.
+   * Gets the height of the window's client area.
+   * @returns {number} The height of the client area in pixels.
    */
   get clientHeight() {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);

package/src/phaser/core/event_manager.js

@@ -2,8 +2,8 @@ import { Signal } from './signal.js';
 
 export class EventManager {
   /**
-   * TBD.
-   * @param {import('../display/display_object.js').DisplayObject} sprite - TBD.
+   * Creates a new EventManager instance.
+   * @param {import('../display/display_object.js').DisplayObject} sprite - Reference to the parent DisplayObject.
    */
   constructor(sprite) {
     this.parent = sprite;
@@ -25,7 +25,7 @@ export class EventManager {
   }
 
   /**
-   * TBD.
+   * Destroys the EventManager and cleans up resources.
    */
   destroy() {
     this._parent = null;
@@ -77,8 +77,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onAddedToGroup signal.
+   * @returns {Signal} The Signal object for the onAddedToGroup event.
    */
   get onAddedToGroup() {
     if (!this._onAddedToGroup) {
@@ -88,8 +88,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onAddedToGroup event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onAddedToGroup$dispatch(...args) {
     if (this._onAddedToGroup) {
@@ -98,8 +98,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onRemovedFromGroup signal.
+   * @returns {Signal} The Signal object for the onRemovedFromGroup event.
    */
   get onRemovedFromGroup() {
     if (!this._onRemovedFromGroup) {
@@ -109,8 +109,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onRemovedFromGroup event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onRemovedFromGroup$dispatch(...args) {
     if (this._onRemovedFromGroup) {
@@ -119,8 +119,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onDestroy signal.
+   * @returns {Signal} The Signal object for the onDestroy event.
    */
   get onDestroy() {
     if (!this._onDestroy) {
@@ -130,8 +130,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onDestroy event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onDestroy$dispatch(...args) {
     if (this._onDestroy) {
@@ -140,8 +140,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onOutOfBounds signal.
+   * @returns {Signal} The Signal object for the onOutOfBounds event.
    */
   get onOutOfBounds() {
     if (!this._onOutOfBounds) {
@@ -151,8 +151,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onOutOfBounds event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onOutOfBounds$dispatch(...args) {
     if (this._onOutOfBounds) {
@@ -161,8 +161,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onEnterBounds signal.
+   * @returns {Signal} The Signal object for the onEnterBounds event.
    */
   get onEnterBounds() {
     if (!this._onEnterBounds) {
@@ -172,8 +172,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onEnterBounds event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onEnterBounds$dispatch(...args) {
     if (this._onEnterBounds) {
@@ -182,8 +182,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onInputOver signal.
+   * @returns {Signal} The Signal object for the onInputOver event.
    */
   get onInputOver() {
     if (!this._onInputOver) {
@@ -193,8 +193,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onInputOver event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onInputOver$dispatch(...args) {
     if (this._onInputOver) {
@@ -203,8 +203,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onInputOut signal.
+   * @returns {Signal} The Signal object for the onInputOut event.
    */
   get onInputOut() {
     if (!this._onInputOut) {
@@ -214,8 +214,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onInputOut event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onInputOut$dispatch(...args) {
     if (this._onInputOut) {
@@ -224,8 +224,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onInputDown signal.
+   * @returns {Signal} The Signal object for the onInputDown event.
    */
   get onInputDown() {
     if (!this._onInputDown) {
@@ -235,8 +235,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onInputDown event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onInputDown$dispatch(...args) {
     if (this._onInputDown) {
@@ -245,8 +245,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onInputUp signal.
+   * @returns {Signal} The Signal object for the onInputUp event.
    */
   get onInputUp() {
     if (!this._onInputUp) {
@@ -256,8 +256,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onInputUp event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onInputUp$dispatch(...args) {
     if (this._onInputUp) {
@@ -266,8 +266,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onDragStart signal.
+   * @returns {Signal} The Signal object for the onDragStart event.
    */
   get onDragStart() {
     if (!this._onDragStart) {
@@ -277,8 +277,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onDragStart event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onDragStart$dispatch(...args) {
     if (this._onDragStart) {
@@ -287,8 +287,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onDragUpdate signal.
+   * @returns {Signal} The Signal object for the onDragUpdate event.
    */
   get onDragUpdate() {
     if (!this._onDragUpdate) {
@@ -298,8 +298,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onDragUpdate event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onDragUpdate$dispatch(...args) {
     if (this._onDragUpdate) {
@@ -308,8 +308,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onDragStop signal.
+   * @returns {Signal} The Signal object for the onDragStop event.
    */
   get onDragStop() {
     if (!this._onDragStop) {
@@ -319,8 +319,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onDragStop event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onDragStop$dispatch(...args) {
     if (this._onDragStop) {
@@ -329,8 +329,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onAnimationStart signal.
+   * @returns {Signal} The Signal object for the onAnimationStart event.
    */
   get onAnimationStart() {
     if (!this._onAnimationStart) {
@@ -340,8 +340,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onAnimationStart event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onAnimationStart$dispatch(...args) {
     if (this._onAnimationStart) {
@@ -350,8 +350,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onAnimationComplete signal.
+   * @returns {Signal} The Signal object for the onAnimationComplete event.
    */
   get onAnimationComplete() {
     if (!this._onAnimationComplete) {
@@ -361,8 +361,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onAnimationComplete event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onAnimationComplete$dispatch(...args) {
     if (this._onAnimationComplete) {
@@ -371,8 +371,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @returns {Signal} TBD.
+   * Gets the onAnimationLoop signal.
+   * @returns {Signal} The Signal object for the onAnimationLoop event.
    */
   get onAnimationLoop() {
     if (!this._onAnimationLoop) {
@@ -382,8 +382,8 @@ export class EventManager {
   }
 
   /**
-   * TBD.
-   * @param {...any} args - TBD.
+   * Dispatches the onAnimationLoop event.
+   * @param {...any} args - Arguments to pass to the signal.
    */
   onAnimationLoop$dispatch(...args) {
     if (this._onAnimationLoop) {