angry-pixel 2.0.16 → 2.0.17

package/lib/index.d.ts

@@ -2400,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;
     };
 }
 
@@ -2729,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>);