angry-pixel 2.0.16 → 2.0.18

package/lib/index.d.ts

@@ -55,7 +55,7 @@ declare function injectable(name: DependencyName): (target: DependencyType) => v
  * }
  * ```
  */
-declare function inject(name: DependencyName): (target: any, propertyKey: PropertyKey, parameterIndex?: number) => void;
+declare function inject(name: DependencyName): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
 
 /**
  * Represents a 2D vector and provides static methods for vector calculations.
@@ -245,8 +245,57 @@ declare class Vector2 {
      * v2.x // 4
      * v2.y // 2
      * ```
+     * @example
+     * ```js
+     * const v1 = new Vector2(3.9, 2.2);
+     * Vector2.round(v1, v1);
+     * v1.x // 4
+     * v1.y // 2
+     * ```
      */
     static round(out: Vector2, a: Vector2): Vector2;
+    /**
+     * Floors a vector
+     *
+     * @param a The vector to floor
+     * @returns The output vector
+     * @example
+     * ```js
+     * const v1 = new Vector2(3.9, 2.2);
+     * const v2 = Vector2.floor(new Vector2(), v1);
+     * v2.x // 3
+     * v2.y // 2
+     * ```
+     * @example
+     * ```js
+     * const v1 = new Vector2(3.9, 2.2);
+     * Vector2.floor(v1, v1);
+     * v1.x // 3
+     * v1.y // 2
+     * ```
+     */
+    static floor(out: Vector2, a: Vector2): Vector2;
+    /**
+     * Ceils a vector
+     *
+     * @param a The vector to ceil
+     * @returns The output vector
+     * @example
+     * ```js
+     * const v1 = new Vector2(3.9, 2.2);
+     * const v2 = Vector2.ceil(new Vector2(), v1);
+     * v2.x // 4
+     * v2.y // 3
+     * ```
+     * @example
+     * ```js
+     * const v1 = new Vector2(3.9, 2.2);
+     * Vector2.ceil(v1, v1);
+     * v1.x // 4
+     * v1.y // 3
+     * ```
+     */
+    static ceil(out: Vector2, a: Vector2): Vector2;
     toString(): string;
 }
 
@@ -372,6 +421,20 @@ declare const range: (start: number, end: number, steps?: number) => number[];
  * @returns true if the number is between the min and the max, false instead
  */
 declare const between: (value: number, min: number, max: number) => boolean;
+/**
+ * Converts the given radians to degrees.
+ * @param radians
+ * @returns degrees
+ */
+declare const radiansToDegrees: (radians: number) => number;
+/**
+ * Converts the given degrees to radians.
+ * @param degrees
+ * @returns radians
+ * @category Math
+ * @public
+ */
+declare const degreesToRadians: (degrees: number) => number;
 
 /** @internal */
 interface Shape {
@@ -1117,7 +1180,11 @@ interface GameConfig {
     height: number;
     /** Enables the debug mode */
     debugEnabled?: boolean;
-    /** Background color of canvas */
+    /** Color of debug elements, default "#00FF00" (green) */
+    debugColor?: string;
+    /** Position of debug text, default "bottom-left" */
+    debugTextPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
+    /** Background color of canvas, default "#000000" (black) */
     canvasColor?: string;
     /** Framerate for physics execution. The allowed values are 60, 120, 180, 240.
      * The higher the framerate, the more accurate the physics will be, but it will consume more processor resources.
@@ -1178,15 +1245,17 @@ declare class AssetManager {
     /**
      * Loads an image asset
      * @param url The asset URL
+     * @param name The asset name [optional]
      * @returns The HTML Image element created
      */
-    loadImage(url: string): HTMLImageElement;
+    loadImage(url: string, name?: string): HTMLImageElement;
     /**
      * Loads an audio asset
      * @param url The asset URL
+     * @param name The asset name [optional]
      * @returns The HTML Audio element created
      */
-    loadAudio(url: string): HTMLAudioElement;
+    loadAudio(url: string, name?: string): HTMLAudioElement;
     /**
      * Loads a font asset
      * @param family The font family name
@@ -1197,21 +1266,34 @@ declare class AssetManager {
     /**
      * Loads an video asset
      * @param url The asset URL
+     * @param name The asset name [optional]
      * @returns The HTML Video element created
      */
-    loadVideo(url: string): HTMLVideoElement;
+    loadVideo(url: string, name?: string): HTMLVideoElement;
     /**
      * Retrieves an image asset
      * @param url The asset URL
      * @returns The HTML Image element
      */
     getImage(url: string): HTMLImageElement;
+    /**
+     * Retrieves an image asset
+     * @param name The asset name
+     * @returns The HTML Image element
+     */
+    getImage(name: string): HTMLImageElement;
     /**
      * Retrieves an audio asset
      * @param url The asset URL
      * @returns The HTML Audio element
      */
     getAudio(url: string): HTMLAudioElement;
+    /**
+     * Retrieves an audio asset
+     * @param name The asset name
+     * @returns The HTML Audio element
+     */
+    getAudio(name: string): HTMLAudioElement;
     /**
      * Retrieves a font asset
      * @param family The font family name
@@ -1224,6 +1306,12 @@ declare class AssetManager {
      * @returns The HTML Video element
      */
     getVideo(url: string): HTMLVideoElement;
+    /**
+     * Retrieves a video asset
+     * @param name The asset name
+     * @returns The HTML Video element
+     */
+    getVideo(name: string): HTMLVideoElement;
     private createAsset;
 }
 
@@ -2400,21 +2488,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;
     };
 }
 
@@ -2479,6 +2573,11 @@ interface VideoRenderData extends RenderData {
  * @category Components
  */
 declare const defaultRenderLayer = "Default";
+/**
+ * Debug render layer
+ * @internal
+ */
+declare const debugRenderLayer = "Debug";
 /**
  * @public
  * @category Components
@@ -2499,6 +2598,8 @@ declare class Camera {
     zoom: number;
     /** In case you have more than one camera, the depth value determines which camera is rendered first. The lesser value, the first to render */
     depth: number;
+    /** Set to TRUE to allow this camera to render debug data (default FALSE) */
+    debug: boolean;
     /** @internal */
     _renderData: CameraData;
     constructor(options?: Partial<CameraOptions>);
@@ -2724,91 +2825,173 @@ declare class SpriteRenderer {
     constructor(options?: Partial<SpriteRendererOptions>);
 }
 
+/**
+ * @internal
+ */
+declare const defaultTextureAtlasOptions: {
+    charRanges: number[];
+    fontSize: number;
+    spacing: number;
+};
 /**
  * @public
  * @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>);
@@ -3401,6 +3584,36 @@ declare function gamePhysicsSystem(): (target: SystemType) => void;
  */
 declare function gamePreRenderSystem(): (target: SystemType) => void;
 
+/**
+ * Applies a decorator manually.
+ * @param decorator The decorator function to be applied.
+ * @param target The target to which the decorator is applied (class, prototype, or constructor argument).
+ * @param propertyKey The property name or constructor argument index (optional).
+ * @public
+ * @category Decorators
+ * @example
+ * ```javascript
+ * decorate(injectable("SomeDependency"), SomeDependency);
+ * ```
+ * @example
+ * ```javascript
+ * decorate(inject("AnotherDependency"), SomeClass, "anotherDependency");
+ * ```
+ * @example
+ * ```javascript
+ *  decorate(inject("AnotherDependency"), SomeClass, 0);
+ * ```
+ * @example
+ * ```javascript
+ * decorate(gamePhysicsSystem(), SomeSystem);
+ * ```
+ * @example
+ * ```javascript
+ * decorate(gamePreRenderSystem(), SomeSystem);
+ * ```
+ */
+declare function decorate(decorator: (...args: any[]) => any, target: any, propertyKey?: string | symbol | number): void;
+
 /**
  * Symbols to be used as dependency identifiers
  * @public
@@ -3418,4 +3631,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, 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 };
+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, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, radiansToDegrees, randomFloat, randomInt, range };