@vpmedia/phaser 1.95.0 → 1.97.0

package/types/phaser/core/loader.d.ts

@@ -1,7 +1,7 @@
 export class Loader {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
+     * Creates a new Loader instance.
+     * @param {import('./game.js').Game} game - Reference to the Phaser Game instance.
      */
     constructor(game: import("./game.js").Game);
     game: import("./game.js").Game;
@@ -43,254 +43,254 @@ export class Loader {
     _loadedPackCount: number;
     _loadedFileCount: number;
     /**
-     * TBD.
-     * @param {import('../display/image.js').Image} sprite - TBD.
-     * @param {number} direction - TBD.
+     * Sets the preload sprite for displaying loading progress.
+     * @param {import('../display/image.js').Image} sprite - The image to use as the preload sprite.
+     * @param {number} direction - The direction of the progress (0 = horizontal, 1 = vertical).
      */
     setPreloadSprite(sprite: import("../display/image.js").Image, direction?: number): void;
     /**
-     * TBD.
+     * Resizes the preload sprite when the window is resized.
      */
     resize(): void;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Checks if a file with the given type and key already exists in the file list.
+     * @param {string} type - The type of file to check for.
+     * @param {string} key - The key of the file to check for.
+     * @returns {boolean} True if the file exists, false otherwise.
      */
     checkKeyExists(type: string, key: string): boolean;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
-     * @returns {number} TBD.
+     * Gets the index of a file in the file list by type and key.
+     * @param {string} type - The type of file to find.
+     * @param {string} key - The key of the file to find.
+     * @returns {number} The index of the file in the list, or -1 if not found.
      */
     getAssetIndex(type: string, key: string): number;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
-     * @returns {{index: number, file: object} | null} TBD.
+     * Gets a file from the file list by type and key.
+     * @param {string} type - The type of file to get.
+     * @param {string} key - The key of the file to get.
+     * @returns {{index: number, file: object} | null} The file and its index, or null if not found.
      */
     getAsset(type: string, key: string): {
         index: number;
         file: object;
     } | null;
     /**
-     * TBD.
-     * @param {boolean} hard - TBD.
-     * @param {boolean} clearEvents - TBD.
+     * Resets the loader state, optionally clearing event listeners.
+     * @param {boolean} hard - Whether to perform a hard reset (clears preload sprite).
+     * @param {boolean} clearEvents - Whether to clear event listeners.
      */
     reset(hard?: boolean, clearEvents?: boolean): void;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {object} properties - TBD.
-     * @param {boolean} overwrite - TBD.
-     * @param {string} extension - TBD.
-     * @returns {Loader} TBD.
+     * Adds a file to the file list for loading.
+     * @param {string} type - The type of file to add.
+     * @param {string} key - The key to identify the file.
+     * @param {string} url - The URL of the file to load.
+     * @param {object} properties - Additional properties for the file.
+     * @param {boolean} overwrite - Whether to overwrite an existing file with the same key.
+     * @param {string} extension - The file extension to use if URL is not provided.
+     * @returns {Loader} This Loader instance for chaining.
      */
     addToFileList(type: string, key?: string, url?: string, properties?: object, overwrite?: boolean, extension?: string): Loader;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {object} properties - TBD.
-     * @returns {Loader} TBD.
+     * Replaces a file in the file list with new properties.
+     * @param {string} type - The type of file to replace.
+     * @param {string} key - The key of the file to replace.
+     * @param {string} url - The new URL for the file.
+     * @param {object} properties - The new properties for the file.
+     * @returns {Loader} This Loader instance for chaining.
      */
     replaceInFileList(type: string, key: string, url: string, properties: object): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {object} data - TBD.
-     * @param {object} callbackContext - TBD.
-     * @returns {Loader} TBD.
+     * Adds a pack file to the file list.
+     * @param {string} key - The key to identify the pack file.
+     * @param {string} url - The URL of the pack file to load.
+     * @param {object} data - The parsed pack data.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @returns {Loader} This Loader instance for chaining.
      */
     pack(key: string, url: string, data: object, callbackContext: object): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {boolean} overwrite - TBD.
-     * @returns {Loader} TBD.
+     * Adds an image file to the file list.
+     * @param {string} key - The key to identify the image file.
+     * @param {string} url - The URL of the image file to load.
+     * @param {boolean} overwrite - Whether to overwrite an existing file with the same key.
+     * @returns {Loader} This Loader instance for chaining.
      */
     image(key: string, url: string, overwrite?: boolean): Loader;
     /**
-     * TBD.
-     * @param {string[]} keys - TBD.
-     * @param {string[]} urls - TBD.
-     * @returns {Loader} TBD.
+     * Adds multiple image files to the file list.
+     * @param {string[]} keys - The keys to identify the image files.
+     * @param {string[]} urls - The URLs of the image files to load.
+     * @returns {Loader} This Loader instance for chaining.
      */
     images(keys: string[], urls: string[]): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {boolean} overwrite - TBD.
-     * @returns {Loader} TBD.
+     * Adds a text file to the file list.
+     * @param {string} key - The key to identify the text file.
+     * @param {string} url - The URL of the text file to load.
+     * @param {boolean} overwrite - Whether to overwrite an existing file with the same key.
+     * @returns {Loader} This Loader instance for chaining.
      */
     text(key: string, url: string, overwrite?: boolean): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {boolean} overwrite - TBD.
-     * @returns {Loader} TBD.
+     * Adds a JSON file to the file list.
+     * @param {string} key - The key to identify the JSON file.
+     * @param {string} url - The URL of the JSON file to load.
+     * @param {boolean} overwrite - Whether to overwrite an existing file with the same key.
+     * @returns {Loader} This Loader instance for chaining.
      */
     json(key: string, url: string, overwrite?: boolean): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {boolean} overwrite - TBD.
-     * @returns {Loader} TBD.
+     * Adds an XML file to the file list.
+     * @param {string} key - The key to identify the XML file.
+     * @param {string} url - The URL of the XML file to load.
+     * @param {boolean} overwrite - Whether to overwrite an existing file with the same key.
+     * @returns {Loader} This Loader instance for chaining.
      */
     xml(key: string, url: string, overwrite?: boolean): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} url - TBD.
-     * @param {number} frameWidth - TBD.
-     * @param {number} frameHeight - TBD.
-     * @param {number} frameMax - TBD.
-     * @param {number} margin - TBD.
-     * @param {number} spacing - TBD.
-     * @returns {Loader} TBD.
+     * Adds a spritesheet file to the file list.
+     * @param {string} key - The key to identify the spritesheet file.
+     * @param {string} url - The URL of the spritesheet file to load.
+     * @param {number} frameWidth - The width of each frame in the spritesheet.
+     * @param {number} frameHeight - The height of each frame in the spritesheet.
+     * @param {number} frameMax - The maximum number of frames to load (-1 for all).
+     * @param {number} margin - The margin around each frame in pixels.
+     * @param {number} spacing - The spacing between frames in pixels.
+     * @returns {Loader} This Loader instance for chaining.
      */
     spritesheet(key: string, url: string, frameWidth: number, frameHeight: number, frameMax?: number, margin?: number, spacing?: number): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string[]} urls - TBD.
-     * @param {boolean} autoDecode - TBD.
-     * @returns {Loader} TBD.
+     * Adds an audio file to the file list.
+     * @param {string} key - The key to identify the audio file.
+     * @param {string[]} urls - The URLs of the audio files to load.
+     * @param {boolean} autoDecode - Whether to automatically decode the audio file.
+     * @returns {Loader} This Loader instance for chaining.
      */
     audio(key: string, urls: string[], autoDecode?: boolean): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} urls - TBD.
-     * @param {string} jsonURL - TBD.
-     * @param {object} jsonData - TBD.
-     * @param {boolean} autoDecode - TBD.
-     * @returns {Loader} TBD.
+     * Adds an audio sprite file to the file list.
+     * @param {string} key - The key to identify the audio sprite file.
+     * @param {string} urls - The URLs of the audio files to load.
+     * @param {string} jsonURL - The URL of the JSON file containing audio sprite data.
+     * @param {object} jsonData - The parsed JSON data containing audio sprite data.
+     * @param {boolean} autoDecode - Whether to automatically decode the audio file.
+     * @returns {Loader} This Loader instance for chaining.
      */
     audioSprite(key: string, urls: string, jsonURL: string, jsonData: object, autoDecode?: boolean): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} textureURL - TBD.
-     * @param {string} atlasURL - TBD.
-     * @param {object} atlasData - TBD.
-     * @param {number} xSpacing - TBD.
-     * @param {number} ySpacing - TBD.
-     * @returns {Loader} TBD.
-     * @throws {Error}
+     * Adds a bitmap font file to the file list.
+     * @param {string} key - The key to identify the bitmap font file.
+     * @param {string} textureURL - The URL of the font texture image.
+     * @param {string} atlasURL - The URL of the XML or JSON file containing font data.
+     * @param {object} atlasData - The parsed data containing font information.
+     * @param {number} xSpacing - The horizontal spacing between characters in pixels.
+     * @param {number} ySpacing - The vertical spacing between characters in pixels.
+     * @returns {Loader} This Loader instance for chaining.
+     * @throws {Error} If the bitmap font atlas data is invalid.
      */
     bitmapFont(key: string, textureURL?: string, atlasURL?: string, atlasData?: object, xSpacing?: number, ySpacing?: number): Loader;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {string} textureURL - TBD.
-     * @param {string} atlasURL - TBD.
-     * @param {object} atlasData - TBD.
-     * @param {number} format - TBD.
-     * @returns {Loader} TBD.
+     * Adds a texture atlas file to the file list.
+     * @param {string} key - The key to identify the texture atlas file.
+     * @param {string} textureURL - The URL of the texture image file.
+     * @param {string} atlasURL - The URL of the JSON or XML file containing atlas data.
+     * @param {object} atlasData - The parsed data containing atlas information.
+     * @param {number} format - The format of the atlas file (JSON or XML).
+     * @returns {Loader} This Loader instance for chaining.
      */
     atlas(key: string, textureURL: string, atlasURL?: string, atlasData?: object, format?: number): Loader;
     /**
-     * TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @returns {Loader} TBD.
+     * Creates a sync point for loading files, ensuring all files in the block are loaded before continuing.
+     * @param {Function} callback - The callback function to execute within the sync point.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @returns {Loader} This Loader instance for chaining.
      */
     withSyncPoint(callback: Function, callbackContext: object): Loader;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
-     * @returns {Loader} TBD.
+     * Adds a sync point to a specific file, preventing other files from loading until this one is processed.
+     * @param {string} type - The type of file to add a sync point to.
+     * @param {string} key - The key of the file to add a sync point to.
+     * @returns {Loader} This Loader instance for chaining.
      */
     addSyncPoint(type: string, key: string): Loader;
     /**
-     * TBD.
-     * @param {string} type - TBD.
-     * @param {string} key - TBD.
+     * Removes a file from the file list if it's not currently loading or loaded.
+     * @param {string} type - The type of file to remove.
+     * @param {string} key - The key of the file to remove.
      */
     removeFile(type: string, key: string): void;
     /**
-     * TBD.
+     * Removes all files from the file list.
      */
     removeAll(): void;
     /**
-     * TBD.
+     * Starts the loading process for all queued files.
      */
     start(): void;
     /**
-     * TBD.
+     * Processes the loading queue, loading files as appropriate.
      */
     processLoadQueue(): void;
     /**
-     * TBD.
-     * @param {boolean} abnormal - TBD.
+     * Finishes the loading process, optionally reporting an abnormal termination.
+     * @param {boolean} abnormal - Whether the loading was terminated abnormally.
      */
     finishedLoading(abnormal?: boolean): void;
     /**
-     * TBD.
-     * @param {object} file - TBD.
-     * @param {string} errorMessage - TBD.
+     * Marks a file as complete or failed, updating the loading state.
+     * @param {object} file - The file to complete or mark as failed.
+     * @param {string} errorMessage - An error message if the file failed to load.
      */
     asyncComplete(file: object, errorMessage?: string): void;
     /**
-     * TBD.
-     * @param {object} pack - TBD.
+     * Processes a pack file, adding its contained files to the loader.
+     * @param {object} pack - The pack file object to process.
      */
     processPack(pack: object): void;
     /**
-     * TBD.
-     * @param {string} url - TBD.
-     * @param {object} file - TBD.
-     * @returns {string} TBD.
+     * Transforms a URL by adding the base URL and path prefix if needed.
+     * @param {string} url - The original URL to transform.
+     * @param {object} file - The file object containing path information.
+     * @returns {string} The transformed URL.
      */
     transformUrl(url: string, file: object): string;
     /**
-     * TBD.
-     * @param {object} file - TBD.
+     * Loads a file using XMLHttpRequest, handling image files specially.
+     * @param {object} file - The file object to load.
      */
     loadFile(file: object): void;
     /**
-     * TBD.
-     * @param {object} file - TBD.
+     * Loads an image file using the Image DOM element.
+     * @param {object} file - The file object to load.
      */
     loadImageTag(file: object): void;
     /**
-     * TBD.
-     * @param {object} file - TBD.
-     * @param {string} url - TBD.
-     * @param {string} type - TBD.
-     * @param {Function} onload - TBD.
-     * @param {Function} onerror - TBD.
+     * Loads a file using XMLHttpRequest with the specified parameters.
+     * @param {object} file - The file object to load.
+     * @param {string} url - The URL of the file to load.
+     * @param {string} type - The expected response type (e.g., 'text', 'arraybuffer').
+     * @param {Function} onload - The function to call when the file loads successfully.
+     * @param {Function} onerror - The function to call if the file fails to load.
      */
     xhrLoad(file: object, url: string, type: string, onload: Function, onerror?: Function): void;
     /**
-     * TBD.
+     * Placeholder for XDomainRequest loading (not implemented).
      */
     xhrLoadWithXDR(): void;
     /**
-     * TBD.
-     * @param {object[]} urls - TBD.
-     * @returns {string} TBD.
+     * Gets the first supported audio URL from a list of URLs.
+     * @param {object[]} urls - The array of URLs to check for supported audio formats.
+     * @returns {string} The first URL with a supported audio format, or null if none found.
      */
     getAudioURL(urls: object[]): string;
     /**
-     * TBD.
-     * @param {object} file - TBD.
-     * @param {XMLHttpRequest} xhr - TBD.
-     * @param {number | string} reason - TBD.
+     * Handles file loading errors, optionally retrying or marking the file as failed.
+     * @param {object} file - The file object that failed to load.
+     * @param {XMLHttpRequest} xhr - The XMLHttpRequest object that failed.
+     * @param {number | string} reason - The error code or message explaining the failure.
      */
     fileError(file: object, xhr?: XMLHttpRequest, reason?: number | string): void;
     /**
@@ -301,9 +301,9 @@ export class Loader {
      */
     fileComplete(file: object, xhr: XMLHttpRequest): void;
     /**
-     * TBD.
-     * @param {object} file - TBD.
-     * @param {XMLHttpRequest} xhr - TBD.
+     * Handles successful file loading, processing the file content appropriately.
+     * @param {object} file - The file object that was loaded successfully.
+     * @param {XMLHttpRequest} xhr - The XMLHttpRequest object containing the file data.
      */
     jsonLoadComplete(file: object, xhr: XMLHttpRequest): void;
     /**
@@ -311,55 +311,55 @@ export class Loader {
      */
     csvLoadComplete(): void;
     /**
-     * TBD.
-     * @param {object} file - TBD.
-     * @param {XMLHttpRequest} xhr - TBD.
+     * Processes JSON file data after loading.
+     * @param {object} file - The file object containing the JSON data.
+     * @param {XMLHttpRequest} xhr - The XMLHttpRequest object containing the file data.
      */
     xmlLoadComplete(file: object, xhr: XMLHttpRequest): void;
     /**
-     * TBD.
-     * @param {object} data - TBD.
-     * @returns {Document} TBD.
+     * Parses XML string data into a DOM Document object.
+     * @param {object} data - The XML string data to parse.
+     * @returns {Document} The parsed DOM Document, or null if parsing failed.
      */
     parseXml(data: object): Document;
     /**
-     * TBD.
+     * Updates the preload sprite's progress indicator.
      */
     updateProgress(): void;
     /**
-     * TBD.
-     * @param {string} message - TBD.
-     * @param {string|object} data - TBD.
+     * Logs a message to the console if logging is enabled.
+     * @param {string} message - The message to log.
+     * @param {string|object} data - Additional data to log with the message.
      */
     log(message: string, data?: string | object): void;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the number of files that have been loaded.
+     * @returns {number} The total number of loaded files.
      */
     totalLoadedFiles(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the number of files that are still queued for loading.
+     * @returns {number} The total number of queued files.
      */
     totalQueuedFiles(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the number of pack files that have been loaded.
+     * @returns {number} The total number of loaded pack files.
      */
     totalLoadedPacks(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the number of pack files that are still queued for loading.
+     * @returns {number} The total number of queued pack files.
      */
     totalQueuedPacks(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the loading progress as a percentage (0-100).
+     * @returns {number} The current loading progress as a percentage.
      */
     get progressFloat(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the loading progress as a rounded percentage (0-100).
+     * @returns {number} The current loading progress as a rounded percentage.
      */
     get progress(): number;
 }

package/types/phaser/core/loader_parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loader_parser.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/loader_parser.js"],"names":[],"mappings":"AASO,gDAJI,OAAO,kCAAkC,EAAE,WAAW,kBACtD,MAAM,GACJ,MAAM,CAQlB;AAUM,mCANI,MAAM,eACN,OAAO,kCAAkC,EAAE,WAAW,YACtD,MAAM,YACN,MAAM,GACJ,MAAM,CAgClB;AAUM,gCANI,MAAM,eACN,OAAO,kCAAkC,EAAE,WAAW,YACtD,MAAM,YACN,MAAM,GACJ,MAAM,CAIlB;AAUM,qCANI,MAAM,eACN,OAAO,kCAAkC,EAAE,WAAW,YACtD,MAAM,YACN,MAAM,GACJ,MAAM,CA4BlB"}
+{"version":3,"file":"loader_parser.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/loader_parser.js"],"names":[],"mappings":"AASO,gDAJM,OAAO,kCAAkC,EAAE,WAAW,kBACtD,MAAM,GACJ,MAAM,CAQpB;AAUM,mCANM,MAAM,eACN,OAAO,kCAAkC,EAAE,WAAW,YACtD,MAAM,YACN,MAAM,GACJ,MAAM,CAgCpB;AAUM,gCANM,MAAM,eACN,OAAO,kCAAkC,EAAE,WAAW,YACtD,MAAM,YACN,MAAM,GACJ,MAAM,CAIpB;AAUM,qCANM,MAAM,eACN,OAAO,kCAAkC,EAAE,WAAW,YACtD,MAAM,YACN,MAAM,GACJ,MAAM,CA4BpB"}

package/types/phaser/core/raf.d.ts

@@ -16,7 +16,7 @@ export class RequestAnimationFrame {
     stop: () => void;
     /**
      * Performs an animation frame request.
-     * @param {number} rafTime - TBD.
+     * @param {number} rafTime - The timestamp provided by the browser's animation frame.
      */
     update: (rafTime: number) => void;
 }

package/types/phaser/core/scene.d.ts

@@ -2,33 +2,39 @@ export class Scene {
     game: any;
     key: string;
     /**
-     * TBD.
+     * Initialize the scene.
+     * This method is called before preload() and create().
      */
     init(): void;
     /**
-     * TBD.
+     * Load assets for the scene.
+     * This method is called after init() and before create().
      */
     preload(): void;
     /**
-     * TBD.
+     * Create the scene.
+     * This method is called after preload() and is where you create your game objects.
      */
     create(): void;
     /**
-     * TBD.
+     * Update the scene.
+     * This method is called every frame while the scene is active.
      */
     update(): void;
     /**
-     * TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
+     * Handle scene resize.
+     * @param {number} width - The new width of the scene.
+     * @param {number} height - The new height of the scene.
      */
     resize(width: number, height: number): void;
     /**
-     * TBD.
+     * Update the scene while paused.
+     * This method is called every frame while the scene is paused.
      */
     pauseUpdate(): void;
     /**
-     * TBD.
+     * Shutdown the scene.
+     * This method is called when the scene is about to be destroyed.
      */
     shutdown(): void;
 }

package/types/phaser/core/scene.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scene.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/scene.js"],"names":[],"mappings":"AAAA;IAKI,UAAgB;IAChB,YAAa;IAGf;;OAEG;IACH,aAEC;IAED;;OAEG;IACH,gBAEC;IAED;;OAEG;IACH,eAEC;IAED;;OAEG;IACH,eAEC;IAED;;;;OAIG;IACH,cAHW,MAAM,UACN,MAAM,QAIhB;IAED;;OAEG;IACH,oBAEC;IAED;;OAEG;IACH,iBAEC;CACF"}
+{"version":3,"file":"scene.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/scene.js"],"names":[],"mappings":"AAAA;IAKI,UAAgB;IAChB,YAAa;IAGf;;;OAGG;IACH,aAEC;IAED;;;OAGG;IACH,gBAEC;IAED;;;OAGG;IACH,eAEC;IAED;;;OAGG;IACH,eAEC;IAED;;;;OAIG;IACH,cAHW,MAAM,UACN,MAAM,QAIhB;IAED;;;OAGG;IACH,oBAEC;IAED;;;OAGG;IACH,iBAEC;CACF"}