angry-pixel 2.0.15 → 2.0.17

package/lib/index.d.ts

@@ -247,6 +247,7 @@ declare class Vector2 {
      * ```
      */
     static round(out: Vector2, a: Vector2): Vector2;
+    toString(): string;
 }
 
 /**
@@ -1226,6 +1227,138 @@ declare class AssetManager {
     private createAsset;
 }
 
+type IntervalOptions = {
+    callback: () => void;
+    delay: number;
+    times?: number;
+    executeImmediately?: boolean;
+};
+/**
+ * Manages the properties associated with time.
+ * @public
+ * @category Managers
+ * @example
+ * ```js
+ * // using deltaTime to increment a timer
+ * this.timer += this.timeManager.deltaTime;
+ *
+ * // using physicsDeltaTime within a physics component to move the object it belongs to
+ * this.transform.position.x += speed * this.timeManager.physicsDeltaTime;
+ *
+ * // stop all time-related interactions by setting the scale to zero
+ * this.timeManager.timeScale = 0;
+ *
+ * // set an interval that will be cleared after being called 5 times
+ * const intervalId = timeManager.setInterval({
+ *     callback: () => console.log("Will be called 5 times!"),
+ *     delay: 1000,
+ *     times: 5,
+ * });
+ *
+ * // set an interval that will be called indefinitely
+ * const intervalId = timeManager.setInterval({
+ *     callback: () => console.log("Will be called indefinitely!"),
+ *     delay: 1000,
+ * });
+ *
+ * // set an interval that will be called immediately and indefinitely
+ * const intervalId = timeManager.setInterval({
+ *     callback: () => console.log("Will be called immediately and indefinitely!"),
+ *     delay: 1000,
+ *     executeImmediately: true,
+ * });
+ *
+ * // clear the interval with the given id
+ * this.timeManager.clearInterval(intervalId);
+ * ```
+ */
+declare class TimeManager {
+    /** @internal */
+    readonly fixedGameFramerate: number;
+    /** @internal */
+    readonly fixedGameDeltaTime: number;
+    /** @internal */
+    readonly fixedPhysicsFramerate: number;
+    /** @internal */
+    readonly fixedPhysicsDeltaTime: number;
+    /**
+     * The scale on which time passes. The default value is 1.\
+     * For example, if set to 2, the time will run at twice the speed.\
+     * If set to 0.5, it will run at half the speed.\
+     * If set to 0, everything associated with the time will stop.
+     */
+    timeScale: number;
+    /** The time difference, in seconds, between the last frame of and the current frame recorded by the browser. */
+    browserDeltaTime: number;
+    /** The time difference, in seconds, between the last frame and the current frame, unaffected by the scale. */
+    unscaledDeltaTime: number;
+    /** The time difference, in seconds, between the last physics frame and the current one, unaffected by the scale. */
+    unscaledPhysicsDeltaTime: number;
+    private maxDeltaTime;
+    private thenForGame;
+    private thenForPhysics;
+    private thenForRender;
+    private lastIntervalId;
+    private intervals;
+    /** The time difference, in seconds, between the last frame and the current frame. */
+    get deltaTime(): number;
+    /** The time difference, in seconds, between the last physics frame and the current one. */
+    get physicsDeltaTime(): number;
+    /** The browser delta time affected by time scale. */
+    get renderDeltaTime(): number;
+    constructor({ physicsFramerate }: GameConfig);
+    /** @internal */
+    updateForRender(time: number): void;
+    /** @internal */
+    updateForGame(time: number): void;
+    /** @internal */
+    updateForPhysics(time: number): void;
+    /** @internal */
+    updateIntervals(): void;
+    /**
+     * Sets a timer which executes a function repeatedly at a fixed time interval.\
+     * If `times` is provided, the interval will be cleared after the function has been called that many times.\
+     * But if `times` is not provided, the interval will continue until it is cleared.\
+     * If `executeImmediately` is set to true, the function will be called immediately after the interval is set.\
+     * Intervals are cleared when loading a new scene.
+     * @param intervalOptions
+     * @returns intervalId
+     * @example
+     * ```ts
+     * const intervalId = timeManager.setInterval({
+     *     callback: () => console.log("Will be called 5 times!"),
+     *     delay: 1000,
+     *     times: 5,
+     * });
+     * ```
+     * @example
+     * ```ts
+     * const intervalId = timeManager.setInterval({
+     *     callback: () => console.log("Will be called indefinitely!"),
+     *     delay: 1000,
+     * });
+     * ```
+     * @example
+     * ```ts
+     * const intervalId = timeManager.setInterval({
+     *     callback: () => console.log("Will be called immediately and indefinitely!"),
+     *     delay: 1000,
+     *     executeImmediately: true,
+     * });
+     * ```
+     */
+    setInterval({ callback, delay, times, executeImmediately }: IntervalOptions): number;
+    /**
+     * Clears the interval with the given id.
+     * @param intervalId
+     */
+    clearInterval(intervalId: number): void;
+    /**
+     * Clears all intervals.
+     */
+    clearAllIntervals(): void;
+}
+
 /**
  * This type represents a scene class
  * @public
@@ -1284,6 +1417,7 @@ declare class SceneManager {
     private readonly systemFactory;
     private readonly entityManager;
     private readonly assetManager;
+    private readonly timeManager;
     private readonly scenes;
     private openingSceneName;
     private currentSceneName;
@@ -1291,7 +1425,7 @@ declare class SceneManager {
     private _loadingScene;
     private _sceneLoadedThisFrame;
     /** @internal */
-    constructor(systemManager: SystemManager, systemFactory: CreateSystemService, entityManager: EntityManager, assetManager: AssetManager);
+    constructor(systemManager: SystemManager, systemFactory: CreateSystemService, entityManager: EntityManager, assetManager: AssetManager, timeManager: TimeManager);
     addScene(sceneType: SceneType, name: string, openingScene?: boolean): void;
     loadScene(name: string): void;
     loadOpeningScene(): void;
@@ -2236,6 +2370,7 @@ interface SpriteRenderData extends RenderData {
     maskColor?: string;
     maskColorMix?: number;
     tintColor?: string;
+    tiled?: Vector2;
 }
 /**
  * Cut the image based on straight coordinates starting from the top left downward.
@@ -2265,21 +2400,27 @@ declare enum TextOrientation {
     RightCenter = 3
 }
 interface TextRenderData extends RenderData {
+    color: string;
+    flipHorizontally: boolean;
+    flipVertically: boolean;
     font: FontFace | string;
-    text: string;
     fontSize: number;
-    color: string;
-    lineSeparation: number;
+    lineHeight: number;
     letterSpacing: number;
+    opacity: number;
     orientation: TextOrientation;
     rotation: number;
-    opacity: number;
+    shadow?: {
+        color: string;
+        offset: Vector2;
+        opacity: number;
+    };
     smooth: boolean;
-    bitmap: {
+    text: string;
+    textureAtlas: {
         charRanges: number[];
         fontSize: number;
-        margin: Vector2;
-        spacing: Vector2;
+        spacing: number;
     };
 }
 
@@ -2526,10 +2667,30 @@ interface SpriteRendererOptions {
     scale: Vector2;
     width: number;
     height: number;
+    tiled: Vector2;
 }
 /**
  * @public
  * @category Components
+ * @example
+ * ```js
+ * spriteRenderer.image = this.assetManager.getImage("image.png");
+ * spriteRenderer.width = 1920;
+ * spriteRenderer.height = 1080;
+ * spriteRenderer.offset = new Vector2(0, 0);
+ * spriteRenderer.flipHorizontally =  false;
+ * spriteRenderer.flipVertically = false;
+ * spriteRenderer.rotation = 0;
+ * spriteRenderer.opacity = 1;
+ * spriteRenderer.maskColor = "#FF0000";
+ * spriteRenderer.maskColorMix = 0;
+ * spriteRenderer.tintColor = "#00FF00";
+ * spriteRenderer.layer = "Default";
+ * spriteRenderer.slice = {x: 0, y:0, width: 1920, height: 1080};
+ * spriteRenderer.scale = new Vector2(1, 1);
+ * spriteRenderer.tiled = new Vector2(1, 1);
+ * spriteRenderer.smooth = false;
+ * ```
  */
 declare class SpriteRenderer {
     /** The render layer */
@@ -2562,6 +2723,8 @@ declare class SpriteRenderer {
     width: number;
     /** Overwrite the original image height */
     height: number;
+    /** Enable tiled draw mode */
+    tiled: Vector2;
     /** @internal */
     _renderData: SpriteRenderData;
     constructor(options?: Partial<SpriteRendererOptions>);
@@ -2572,86 +2735,160 @@ declare class SpriteRenderer {
  * @category Components
  */
 interface TextRendererOptions {
-    layer: string;
-    text: string;
+    /** The text color */
+    color: string;
+    /** Flip the text horizontally */
+    flipHorizontally: boolean;
+    /** Flip the text vertically */
+    flipVertically: boolean;
+    /** The font family to use */
     font: FontFace | string;
+    /** The size of the font in pixels. */
     fontSize: number;
-    width: number;
+    /** The height of the invisible box where the text is rendered */
     height: number;
-    offset: Vector2;
-    color: string;
-    lineSeparation: number;
+    /** The render layer */
+    layer: string;
+    /** The space between chars in pixels */
     letterSpacing: number;
-    charRanges: number[];
-    smooth: boolean;
-    rotation: number;
+    /** The height of the line in pixels. Default value is equal to the font size */
+    lineHeight: number;
+    /** X-axis and Y-axis offset */
+    offset: Vector2;
+    /** Change the opacity between 1 and 0 */
     opacity: number;
+    /** Direction in which the text will be rendered. */
     orientation: TextOrientation;
-    bitmapMargin: Vector2;
-    bitmapSpacing: Vector2;
+    /** Text rotation in radians */
+    rotation: number;
+    /** Smoothing pixels (not recommended for bitmap fonts) */
+    smooth: boolean;
+    /** Shadow text configuration */
+    shadow?: {
+        /** Shadow text color */
+        color: string;
+        /** Shadow text offset in pixels */
+        offset: Vector2;
+        /** Shadow text opacity */
+        opacity: number;
+    };
+    /** The text to render */
+    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. */
+        charRanges?: number[];
+        /** The size of the font in pixels for bitmap fonts. */
+        fontSize?: number;
+        /** Spacing in pixels to correct badly sliced characters. */
+        spacing?: number;
+    };
+    /** The width of the invisible box where the text is rendered */
+    width: number;
 }
 /**
  * The TextRenderer component allows to render text using font families, colors, and other configuration options.
  * @public
  * @category Components
+ *  @example
+ * ```typescript
+ * const textRenderer = new TextRenderer({
+ *   text: "Hello World!",
+ *   color: "#FFFFFF",
+ *   fontSize: 24,
+ *   font: "Arial",
+ *   width: 1920,
+ *   height: 32,
+ *   layer: "TextLayer",
+ * });
+ * ```
  * @example
- * ```js
- *   textRenderer.layer: "default";
- *   textRenderer.text: "Hello world!";
- *   textRenderer.font: "Arial";
- *   textRenderer.fontSize: 16;
- *   textRenderer.width: 160;
- *   textRenderer.height: 16;
- *   textRenderer.color: "#000000";
- *   textRenderer.offset: new Vector2();
- *   textRenderer.lineSeparation: 0;
- *   textRenderer.letterSpacing: 0;
- *   textRenderer.charRanges: [32, 126, 161, 255];
- *   textRenderer.smooth: false;
- *   textRenderer.rotation: 0;
- *   textRenderer.opacity: 1;
- *   textRenderer.orientation: TextOrientation.RightDown;
- *   textRenderer.bitmapMargin: new Vector2();
- *   textRenderer.bitmapSpacing: new Vector2();
+ * ```typescript
+ * const textRenderer = new TextRenderer({
+ *   text: "Hello World!",
+ *   color: "#FFFFFF",
+ *   fontSize: 24,
+ *   width: 1920,
+ *   height: 32,
+ *   opacity: 1,
+ *   layer: "TextLayer",
+ *   orientation: TextOrientation.RightCenter,
+ *   shadow: {
+ *     color: "#00FF00",
+ *     offset: new Vector2(3, -3),
+ *     opacity: 0.5,
+ *   },
+ *   textureAtlas: {
+ *     charRanges: [32, 126, 161, 255, 0x3040, 0x309f],
+ *     fontSize: 64,
+ *     spacing: 4,
+ *   },
+ *   font: "Arial",
+ *   flipHorizontally: false,
+ *   flipVertically: false,
+ *   letterSpacing: 0,
+ *   lineHeight: 24,
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ *   smooth: false,
+ * });
  * ```
  */
 declare class TextRenderer {
-    /** The render layer */
-    layer: string;
-    /** The text to render */
-    text: string;
+    /** The text color */
+    color: string;
+    /** Flip the text horizontally */
+    flipHorizontally: boolean;
+    /** Flip the text vertically */
+    flipVertically: boolean;
     /** The font family to use */
     font: FontFace | string;
     /** The size of the font in pixels. */
     fontSize: number;
-    /** The width of the invisible box where the text is rendered */
-    width: number;
     /** The height of the invisible box where the text is rendered */
     height: number;
-    /** X-axis and Y-axis offset */
-    offset: Vector2;
-    /** The text color */
-    color: string;
-    /** The separation between lines in pixels */
-    lineSeparation: number;
+    /** The render layer */
+    layer: string;
     /** The space between chars in pixels */
     letterSpacing: number;
-    /** 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. */
-    charRanges: number[];
-    /** Smoothing pixels (not recommended for bitmap fonts) */
-    smooth: boolean;
-    /** Text rotation in radians */
-    rotation: number;
+    /** The height of the line in pixels. Default value is equal to the font size */
+    lineHeight: number;
+    /** X-axis and Y-axis offset */
+    offset: Vector2;
     /** Change the opacity between 1 and 0 */
     opacity: number;
     /** Direction in which the text will be rendered. */
     orientation: TextOrientation;
-    /** Margin in pixels to correct badly sliced characters. */
-    bitmapMargin: Vector2;
-    /** Spacing in pixels to correct badly sliced characters. */
-    bitmapSpacing: Vector2;
+    /** Text rotation in radians */
+    rotation: number;
+    /** Shadow text configuration */
+    shadow: {
+        /** Shadow text color */
+        color: string;
+        /** Shadow text offset in pixels */
+        offset: Vector2;
+        /** Shadow text opacity */
+        opacity: number;
+    };
+    /** Smoothing pixels (not recommended for bitmap fonts) */
+    smooth: boolean;
+    /** The text to render */
+    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. */
+        charRanges?: number[];
+        /** The size of the font in pixels for bitmap fonts. */
+        fontSize?: number;
+        /** Spacing in pixels to correct badly sliced characters. */
+        spacing?: number;
+    };
+    /** The width of the invisible box where the text is rendered */
+    width: number;
     /** @internal */
     _renderData: TextRenderData;
     constructor(options?: Partial<TextRendererOptions>);
@@ -3178,63 +3415,6 @@ declare class InputManager {
     constructor();
 }
 
-/**
- * Manages the properties associated with time.
- * @public
- * @category Managers
- * @example
- * ```js
- * // using deltaTime to increment a timer
- * this.timer += this.timeManager.deltaTime;
- *
- * // using physicsDeltaTime within a physics component to move the object it belongs to
- * this.transform.position.x += speed * this.timeManager.physicsDeltaTime;
- *
- * // stop all time-related interactions by setting the scale to zero
- * this.timeManager.timeScale = 0;
- * ```
- */
-declare class TimeManager {
-    /** @internal */
-    readonly fixedGameFramerate: number;
-    /** @internal */
-    readonly fixedGameDeltaTime: number;
-    /** @internal */
-    readonly fixedPhysicsFramerate: number;
-    /** @internal */
-    readonly fixedPhysicsDeltaTime: number;
-    /**
-     * The scale on which time passes. The default value is 1.\
-     * For example, if set to 2, the time will run at twice the speed.\
-     * If set to 0.5, it will run at half the speed.\
-     * If set to 0, everything associated with the time will stop.
-     */
-    timeScale: number;
-    /** The time difference, in seconds, between the last frame of and the current frame recorded by the browser. */
-    browserDeltaTime: number;
-    /** The time difference, in seconds, between the last frame and the current frame, unaffected by the scale. */
-    unscaledDeltaTime: number;
-    /** The time difference, in seconds, between the last physics frame and the current one, unaffected by the scale. */
-    unscaledPhysicsDeltaTime: number;
-    private maxDeltaTime;
-    private thenForGame;
-    private thenForPhysics;
-    private thenForRender;
-    /** The time difference, in seconds, between the last frame and the current frame. */
-    get deltaTime(): number;
-    /** The time difference, in seconds, between the last physics frame and the current one. */
-    get physicsDeltaTime(): number;
-    /** The browser delta time affected by time scale. */
-    get renderDeltaTime(): number;
-    constructor({ physicsFramerate }: GameConfig);
-    /** @internal */
-    updateForRender(time: number): void;
-    /** @internal */
-    updateForGame(time: number): void;
-    /** @internal */
-    updateForPhysics(time: number): void;
-}
-
 /**
  * Abstract class which can be used to create Systems.\
  * It includes the following dependencies: EntityManager, AssetManager, SceneManager, TimeManager, InputManager, CollisionRepository.
@@ -3256,7 +3436,12 @@ declare abstract class GameSystem implements System {
     protected readonly timeManager: TimeManager;
     protected readonly inputManager: InputManager;
     protected readonly collisionRepository: CollisionRepository;
+    protected readonly gameConfig: GameConfig;
     onUpdate(): void;
+    onCreate(): void;
+    onEnabled(): void;
+    onDisabled(): void;
+    onDestroy(): void;
 }
 
 /**
@@ -3313,4 +3498,4 @@ declare const Symbols: {
     TimeManager: symbol;
 };
 
-export { Animation, type AnimationSlice, Animator, type AnimatorOptions, AssetManager, AudioPlayer, type AudioPlayerAction, type AudioPlayerOptions, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, Children, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, type DependencyName, type DependencyType, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, InputManager, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, Parent, Polygon, PolygonCollider, type PolygonColliderOptions, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, Scene, SceneManager, type SceneType, type SearchCriteria, type SearchResult, ShadowRenderer, type ShadowRendererOptions, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, Symbols, type System, type SystemGroup, SystemManager, type SystemType, TextOrientation, 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, defaultRenderLayer, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, randomFloat, randomInt, range };
+export { Animation, type AnimationSlice, Animator, type AnimatorOptions, AssetManager, AudioPlayer, type AudioPlayerAction, type AudioPlayerOptions, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, Children, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, type DependencyName, type DependencyType, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, Parent, Polygon, PolygonCollider, type PolygonColliderOptions, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, Scene, SceneManager, type SceneType, type SearchCriteria, type SearchResult, ShadowRenderer, type ShadowRendererOptions, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, Symbols, type System, type SystemGroup, SystemManager, type SystemType, TextOrientation, 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, defaultRenderLayer, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, randomFloat, randomInt, range };