angry-pixel 2.3.3 → 2.3.4

package/lib/index.d.ts

@@ -3490,7 +3490,6 @@ interface TilemapRenderData extends RenderData {
     tiles: number[];
     tilemap: Tilemap;
     tileset: Tileset$1;
-    tileAnimations?: Map<number, number>;
     smooth?: boolean;
     flipHorizontal?: boolean;
     flipVertical?: boolean;
@@ -3503,12 +3502,30 @@ interface TilemapRenderData extends RenderData {
 }
 type Tileset$1 = {
     image: HTMLImageElement;
-    width: number;
     tileWidth: number;
     tileHeight: number;
-    margin?: Vector2;
-    spacing?: Vector2;
-    correction?: Vector2;
+    /** Space in pixels between the tiles and the four edges of the image */
+    margin?: number;
+    /** Space in pixels between adjacent tiles */
+    spacing?: number;
+    /** Maps each animated tile id to the tile id currently displayed. @internal */
+    _animationState?: Map<number, number>;
+    /** Tileset values in texture coordinates. Computed once by the renderer. @internal */
+    _texData?: TilesetTexData;
+};
+/**
+ * Tileset values expressed in texture coordinates (0 to 1), plus the number of columns of the tileset.
+ * @internal
+ */
+type TilesetTexData = {
+    /** The width of the tileset (in tiles) */
+    columns: number;
+    /** The margin of the image */
+    margin: Vector2;
+    /** The distance between the origin of two adjacent tiles */
+    step: Vector2;
+    /** The size of a tile */
+    tileSize: Vector2;
 };
 type Tilemap = {
     width: number;
@@ -4111,7 +4128,7 @@ declare const defaultTextureAtlasOptions: {
  *     opacity: 0.5,
  *   },
  *   textureAtlas: {
- *     charRanges: [32, 126, 161, 255, 0x3040, 0x309f],
+ *     charRanges: [32, 132, 161, 255, 0x3040, 0x309f],
  *     fontSize: 64,
  *     spacing: 4,
  *   },
@@ -4166,9 +4183,15 @@ interface TextRendererOptions {
     text: string;
     /** The texture atlas configuration */
     textureAtlas: {
-        /** Range of characters covered by the component defined in number pairs.
-         * The default value is [32, 126, 161, 255], this means that the component
-         * will render characters from 32 to 126 and from 161 to 255. */
+        /** Ranges of characters covered by the component, defined as pairs of
+         * Unicode code points (each pair is an inclusive from–to range).
+         * The default value is [32, 132, 161, 255], which covers Basic Latin
+         * (letters, digits and punctuation) and the Latin-1 Supplement
+         * (accented letters and symbols used by Western European languages).
+         * Additional pairs can be appended to render other alphabets, e.g.
+         * [0x3040, 0x309F] for Japanese Hiragana or [0x0400, 0x04FF] for Cyrillic.
+         * See the official Unicode Character Code Charts to find the range of
+         * each alphabet: {@link https://www.unicode.org/charts/} */
         charRanges?: number[];
         /** The size of the font in pixels for bitmap fonts. */
         fontSize?: number;
@@ -4219,7 +4242,7 @@ interface TextRendererOptions {
  *     opacity: 0.5,
  *   },
  *   textureAtlas: {
- *     charRanges: [32, 126, 161, 255, 0x3040, 0x309f],
+ *     charRanges: [32, 132, 161, 255, 0x3040, 0x309f],
  *     fontSize: 64,
  *     spacing: 4,
  *   },
@@ -4276,9 +4299,15 @@ declare class TextRenderer {
     text: string;
     /** The texture atlas configuration */
     textureAtlas: {
-        /** Range of characters covered by the component defined in number pairs.
-         * The default value is [32, 126, 161, 255], this means that the component
-         * will render characters from 32 to 126 and from 161 to 255. */
+        /** Ranges of characters covered by the component, defined as pairs of
+         * Unicode code points (each pair is an inclusive from–to range).
+         * The default value is [32, 132, 161, 255], which covers Basic Latin
+         * (letters, digits and punctuation) and the Latin-1 Supplement
+         * (accented letters and symbols used by Western European languages).
+         * Additional pairs can be appended to render other alphabets, e.g.
+         * [0x3040, 0x309F] for Japanese Hiragana or [0x0400, 0x04FF] for Cyrillic.
+         * See the official Unicode Character Code Charts to find the range of
+         * each alphabet: {@link https://www.unicode.org/charts/} */
         charRanges?: number[];
         /** The size of the font in pixels for bitmap fonts. */
         fontSize?: number;
@@ -4304,11 +4333,10 @@ declare class TextRenderer {
  *   layer: "Default",
  *   tileset: {
  *     image: this.assetManager.getImage("tileset.png"),
- *     width: 10,
  *     tileWidth: 32,
  *     tileHeight: 32,
- *     margin: new Vector2(0, 0),
- *     spacing: new Vector2(0, 0)
+ *     margin: 0,
+ *     spacing: 0
  *   },
  *   data: [1, 2, 3, 4],
  *   chunks: [],
@@ -4338,7 +4366,6 @@ interface TilemapRendererOptions {
     maskColorMix: number;
     opacity: number;
     smooth: boolean;
-    animations: Map<number, TileAnimation>;
 }
 /**
  * The TilemapRenderer component renders 2D tile-based maps to the screen.\
@@ -4354,11 +4381,10 @@ interface TilemapRendererOptions {
  *   layer: "Default",
  *   tileset: {
  *     image: this.assetManager.getImage("tileset.png"),
- *     width: 10,
  *     tileWidth: 32,
  *     tileHeight: 32,
- *     margin: new Vector2(0, 0),
- *     spacing: new Vector2(0, 0)
+ *     margin: 0,
+ *     spacing: 0
  *   },
  *   data: [1, 2, 3, 4],
  *   chunks: [],
@@ -4401,14 +4427,10 @@ declare class TilemapRenderer {
     maskColorMix: number;
     /** TRUE for smooth pixels (not recommended for pixel art) */
     smooth: boolean;
-    /** Animated tiles, keyed by the tile id to animate. */
-    animations: Map<number, TileAnimation>;
     /** @internal */
     _processed: boolean;
     /** @internal */
     _renderData: TilemapRenderData[];
-    /** Maps each animated tile id to the tile id currently displayed. @internal */
-    _tileAnimationState: Map<number, number>;
     /** @internal */
     static componentName: string;
     constructor(options?: Partial<TilemapRendererOptions>);
@@ -4431,18 +4453,23 @@ interface TileAnimationOptions {
 }
 /**
  * TileAnimation cycles a tile through a sequence of tile ids from the tileset.\
- * It is assigned to a {@link TilemapRenderer} keyed by the tile id that should animate.
+ * It is assigned to a {@link Tileset} keyed by the tile id that should animate,\
+ * so every tilemap using that tileset plays the animation in sync.
  * @public
  * @category Components Configuration
  * @example
  * ```js
  * const tilemapRenderer = new TilemapRenderer({
- *   tileset: { image: "tileset.png", width: 10, tileWidth: 32, tileHeight: 32 },
+ *   tileset: {
+ *     image: "tileset.png",
+ *     tileWidth: 32,
+ *     tileHeight: 32,
+ *     animations: new Map([
+ *       [3, new TileAnimation({ tiles: [3, 4, 5], fps: 6 })]
+ *     ])
+ *   },
  *   data: [1, 2, 3, 4],
- *   width: 2,
- *   animations: new Map([
- *     [3, new TileAnimation({ tiles: [3, 4, 5], fps: 6 })]
- *   ])
+ *   width: 2
  * });
  * ```
  */
@@ -4459,22 +4486,36 @@ declare class TileAnimation {
 }
 /**
  * The Tileset configuration defines the properties of a tileset used by the TilemapRenderer.\
- * It specifies the source image containing the tiles, the dimensions of the tileset and individual tiles,\
- * and optional margin and spacing between tiles. This configuration is essential for properly\
- * slicing and rendering tiles from the tileset image.
+ * It specifies the source image containing the tiles, the size of the individual tiles,\
+ * and the optional margin and spacing of the image. The number of columns of the tileset\
+ * is obtained from the image. The tileset cannot be updated at runtime.
  * @public
  * @category Components Configuration
+ * @example
+ * ```js
+ * // a tileset of 16x16 tiles extruded by 1 pixel
+ * const tileset = {
+ *   image: this.assetManager.getImage("tileset.png"),
+ *   tileWidth: 16,
+ *   tileHeight: 16,
+ *   margin: 1,
+ *   spacing: 2
+ * };
+ * ```
  */
 type Tileset = {
     /** The tileset image element */
     image: HTMLImageElement | string;
-    width: number;
     tileWidth: number;
     tileHeight: number;
-    /** Margin of the tile in pixels (space in the top and the left) */
-    margin?: Vector2;
-    /** Spacing of the tile in pixels (space in the bottom and the right) */
-    spacing?: Vector2;
+    /** Space in pixels between the tiles and the four edges of the image */
+    margin?: number;
+    /** Space in pixels between adjacent tiles */
+    spacing?: number;
+    /** Animated tiles, keyed by the tile id to animate */
+    animations?: Map<number, TileAnimation>;
+    /** Maps each animated tile id to the tile id currently displayed. @internal */
+    _animationState?: Map<number, number>;
 };
 /**
  * Chunk of tile data