angry-pixel 2.3.2 → 2.3.4

package/lib/index.d.ts

@@ -3170,6 +3170,13 @@ interface RigidBodyOptions {
      * @public
      */
     acceleration: Vector2;
+    /**
+     * Collision layers for which this body behaves as static. When a Dynamic body whose collider layer
+     * is listed here collides with this body, only the other body is repositioned, as if this one were static.
+     * This body still behaves as its own type (e.g. Dynamic) for every other collision.
+     * @public
+     */
+    staticForLayers: string[];
 }
 /**
  * The RigidBody component enables physics simulation for an entity, allowing it to interact with other physics-enabled objects in the game world.\
@@ -3235,6 +3242,13 @@ declare class RigidBody {
      * @public
      */
     acceleration: Vector2;
+    /**
+     * Collision layers for which this body behaves as static. When a Dynamic body whose collider layer
+     * is listed here collides with this body, only the other body is repositioned, as if this one were static.
+     * This body still behaves as its own type (e.g. Dynamic) for every other collision.
+     * @public
+     */
+    staticForLayers: string[];
     /** @internal */
     static componentName: string;
     constructor(options?: Partial<RigidBodyOptions>);
@@ -3488,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;
@@ -4096,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,
  *   },
@@ -4151,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;
@@ -4204,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,
  *   },
@@ -4261,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;
@@ -4289,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,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: [],
@@ -4393,24 +4435,87 @@ declare class TilemapRenderer {
     static componentName: string;
     constructor(options?: Partial<TilemapRendererOptions>);
 }
+/**
+ * TileAnimation configuration
+ * @public
+ * @category Components Configuration
+ * @example
+ * ```js
+ * const waterAnimation = new TileAnimation({
+ *   tiles: [5, 6, 7, 8],
+ *   fps: 6
+ * });
+ * ```
+ */
+interface TileAnimationOptions {
+    tiles: number[];
+    fps?: number;
+}
+/**
+ * TileAnimation cycles a tile through a sequence of tile ids from the tileset.\
+ * 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",
+ *     tileWidth: 32,
+ *     tileHeight: 32,
+ *     animations: new Map([
+ *       [3, new TileAnimation({ tiles: [3, 4, 5], fps: 6 })]
+ *     ])
+ *   },
+ *   data: [1, 2, 3, 4],
+ *   width: 2
+ * });
+ * ```
+ */
+declare class TileAnimation {
+    /** The sequence of tile ids to cycle through. */
+    tiles: number[];
+    /** The animation speed in frames per second. */
+    fps: number;
+    /** The current frame of the animation. */
+    currentFrame: number;
+    /** The current time of the animation. */
+    currentTime: number;
+    constructor(options?: TileAnimationOptions);
+}
 /**
  * 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
@@ -5131,4 +5236,4 @@ declare const SYMBOLS: {
     TimeManager: symbol;
 };
 
-export { Animation, type AnimationOptions, type AnimationSlice, Animator, type AnimatorOptions, type Archetype, AssetManager, AudioPlayer, type AudioPlayerOptions, type AudioSource, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, DarknessRenderer, type DarknessRendererOptions, type DependencyName, type DependencyType, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, GeometricRenderer, type GeometricRendererOptions, GeometricShape, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, type PlaySfxOptions, Polygon, PolygonCollider, type PolygonColliderOptions, type PropertyKey, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, SYMBOLS, Scene, SceneManager, type SceneType, type SearchResult, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, type System, type SystemGroup, SystemManager, type SystemType, TextAlignment, TextRenderer, type TextRendererOptions, type TiledChunk, type TiledLayer, type TiledObject, type TiledObjectLayer, type TiledProperty, type TiledTilemap, TiledWrapper, type TiledWrapperOptions, TilemapCollider, type TilemapColliderOptions, TilemapOrientation, TilemapRenderer, type TilemapRendererOptions, type Tileset, TimeManager, type TouchInteraction, TouchScreen, Transform, type TransformOptions, Vector2, type VibrationInput, VideoRenderer, type VideoRendererOptions, between, clamp, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, playSfx, radiansToDegrees, randomFloat, randomInt, range, rgbToHex, stopSfx };
+export { Animation, type AnimationOptions, type AnimationSlice, Animator, type AnimatorOptions, type Archetype, AssetManager, AudioPlayer, type AudioPlayerOptions, type AudioSource, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, DarknessRenderer, type DarknessRendererOptions, type DependencyName, type DependencyType, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, GeometricRenderer, type GeometricRendererOptions, GeometricShape, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, type PlaySfxOptions, Polygon, PolygonCollider, type PolygonColliderOptions, type PropertyKey, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, SYMBOLS, Scene, SceneManager, type SceneType, type SearchResult, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, type System, type SystemGroup, SystemManager, type SystemType, TextAlignment, TextRenderer, type TextRendererOptions, TileAnimation, type TileAnimationOptions, type TiledChunk, type TiledLayer, type TiledObject, type TiledObjectLayer, type TiledProperty, type TiledTilemap, TiledWrapper, type TiledWrapperOptions, TilemapCollider, type TilemapColliderOptions, TilemapOrientation, TilemapRenderer, type TilemapRendererOptions, type Tileset, TimeManager, type TouchInteraction, TouchScreen, Transform, type TransformOptions, Vector2, type VibrationInput, VideoRenderer, type VideoRendererOptions, between, clamp, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, playSfx, radiansToDegrees, randomFloat, randomInt, range, rgbToHex, stopSfx };