littlejsengine 1.14.4 → 1.14.7

package/README.md

@@ -1,6 +1,6 @@
 # LittleJS - The Tiny Fast JavaScript Game Engine
 
-<div align=center>
+<div align='center'>
     
 ![LittleJS Screenshot](examples/logo.png)
 
@@ -22,7 +22,7 @@ The code is clean and well documented with some fun examples to get you started
 
 *The Second Annual LittleJS Game Jam will take place From Oct 3 to Nov 3! Unleash your creativity and develop amazing games using the LittleJS game engine. 🕹️🎮 [Sign up today and get more info about the jam on itch.io!](https://itch.io/jam/littlejs-game-jam-2025)*
 
-<div align=center>
+<div align='center'>
 
 ## [Demos](https://killedbyapixel.github.io/LittleJS/examples) | [Docs](https://killedbyapixel.github.io/LittleJS/docs) | [Trailer](https://youtu.be/chuBzGjv7Ms) | [Discord](https://discord.gg/zb7hcGkyZe) | [Tutorial](https://github.com/KilledByAPixel/LittleJS/blob/main/examples/breakoutTutorial/README.md) | [FAQ](https://github.com/KilledByAPixel/LittleJS/blob/main/FAQ.md)
 
@@ -80,7 +80,7 @@ LittleJS is a small but powerful game engine with many features and no dependenc
 
 To get started download the latest LittleJS package from GitHub or install via npm: ```npm install littlejsengine```
 
-*You need to run a local web server to run LittleJS games during development!* You may see a console error like "The image element contains cross-origin data." Don't panic, it's easy to fix! If you are using [Visual Studio Code](https://code.visualstudio.com/) there is a [Live Preview Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) that will handle this for you automatically. Another option is to setup a simple local web server like [http-server](https://www.npmjs.com/package/http-server) via npm.
+*You need to run a local web server to run LittleJS games during development!* You may see a console error like 'The image element contains cross-origin data.' Don't panic, it's easy to fix! If you are using [Visual Studio Code](https://code.visualstudio.com/) there is a [Live Preview Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) that will handle this for you automatically. Another option is to setup a simple local web server like [http-server](https://www.npmjs.com/package/http-server) via npm.
 
 - [Watch this GitNation talk](https://youtu.be/_dXKU0WgAj8?si=ZDXLYAFDWp54hrGT) to hear more about LittleJS works and get some tips on how to use it.
 - Learn how to make a simple game from scratch with [The Breakout Tutorial.](https://github.com/KilledByAPixel/LittleJS/tree/main/examples/breakoutTutorial)

package/dist/littlejs.d.ts

@@ -168,12 +168,12 @@ declare module "littlejsengine" {
     export function debugPoly(pos: Vector2, points: Array<Vector2>, color?: string, time?: number, angle?: number, fill?: boolean): void;
     /** Draw a debug circle in world space
      *  @param {Vector2} pos
-     *  @param {number}  [radius]
+     *  @param {number}  [size] - diameter
      *  @param {string}  [color]
      *  @param {number}  [time]
      *  @param {boolean} [fill]
      *  @memberof Debug */
-    export function debugCircle(pos: Vector2, radius?: number, color?: string, time?: number, fill?: boolean): void;
+    export function debugCircle(pos: Vector2, size?: number, color?: string, time?: number, fill?: boolean): void;
     /** Draw a debug point in world space
      *  @param {Vector2} pos
      *  @param {string}  [color]
@@ -268,6 +268,10 @@ declare module "littlejsengine" {
      *  @default
      *  @memberof Settings */
     export let canvasColorTiles: boolean;
+    /** Color to clear the canvas to before render
+     *  @type {Color}
+     *  @memberof Draw */
+    export let canvasClearColor: Color;
     /** The max size of the canvas, centered if window is larger
      *  @type {Vector2}
      *  @default Vector2(1920,1080)
@@ -467,6 +471,10 @@ declare module "littlejsengine" {
      *  @param {boolean} colorTiles
      *  @memberof Settings */
     export function setCanvasColorTiles(colorTiles: boolean): void;
+    /** Set color to clear the canvas to before render
+     *  @param {Color} color
+     *  @memberof Settings */
+    export function setCanvasClearColor(color: Color): void;
     /** Set max size of the canvas
      *  @param {Vector2} size
      *  @memberof Settings */
@@ -1105,6 +1113,9 @@ declare module "littlejsengine" {
         /** Get percentage elapsed based on time it was set to, returns 0 if not set
          * @return {number} */
         getPercent(): number;
+        /** Get the time this timer was set to, returns 0 if not set
+         * @return {number} */
+        getSetTime(): number;
         /** Returns this timer expressed as a string
          * @return {string} */
         toString(): string;
@@ -1212,14 +1223,6 @@ declare module "littlejsengine" {
      *  @type {Color}
      *  @memberof Utilities */
     export const MAGENTA: Color;
-    /** Array containing texture info for batch rendering system
-     *  @type {Array<TextureInfo>}
-     *  @memberof Draw */
-    export let textureInfos: Array<TextureInfo>;
-    /** Keeps track of how many draw calls there were each frame for debugging
-     *  @type {number}
-     *  @memberof Draw */
-    export let drawCount: number;
     /**
      * Create a tile info object using a grid based system
      * - This can take vecs or floats for easier use and conversion
@@ -1245,8 +1248,9 @@ declare module "littlejsengine" {
          *  @param {Vector2} [size=tileSizeDefault] - Size of tile in pixels
          *  @param {number}  [textureIndex]         - Texture index to use
          *  @param {number}  [padding]              - How many pixels padding around tiles
+         *  @param {number}  [bleedScale]           - How many pixels smaller to draw tiles
          */
-        constructor(pos?: Vector2, size?: Vector2, textureIndex?: number, padding?: number);
+        constructor(pos?: Vector2, size?: Vector2, textureIndex?: number, padding?: number, bleedScale?: number);
         /** @property {Vector2} - Top left corner of tile in pixels */
         pos: Vector2;
         /** @property {Vector2} - Size of tile in pixels */
@@ -1257,6 +1261,8 @@ declare module "littlejsengine" {
         padding: number;
         /** @property {TextureInfo} - The texture info for this tile */
         textureInfo: TextureInfo;
+        /** @property {float} - Shrinks tile by this many pixels to prevent neighbors bleeding */
+        bleedScale: number;
         /** Returns a copy of this tile offset by a vector
         *  @param {Vector2} offset - Offset to apply in pixels
         *  @return {TileInfo}
@@ -1342,6 +1348,14 @@ declare module "littlejsengine" {
      *  @type {Vector2}
      *  @memberof Draw */
     export let mainCanvasSize: Vector2;
+    /** Array containing texture info for batch rendering system
+     *  @type {Array<TextureInfo>}
+     *  @memberof Draw */
+    export let textureInfos: Array<TextureInfo>;
+    /** Keeps track of how many draw calls there were each frame for debugging
+     *  @type {number}
+     *  @memberof Draw */
+    export let drawCount: number;
     /** Convert from screen to world space coordinates
      *  @param {Vector2} screenPos
      *  @return {Vector2}
@@ -1609,6 +1623,7 @@ declare module "littlejsengine" {
      *  @memberof WebGL */
     export function glCreateProgram(vsSource: string, fsSource: string): WebGLProgram;
     /** Create WebGL texture from an image and init the texture settings
+     *  Restores the active texture when done
      *  @param {HTMLImageElement|HTMLCanvasElement|OffscreenCanvas} [image]
      *  @return {WebGLTexture}
      *  @memberof WebGL */
@@ -1617,7 +1632,7 @@ declare module "littlejsengine" {
      *  @param {WebGLTexture} [texture]
      *  @memberof WebGL */
     export function glDeleteTexture(texture?: WebGLTexture): void;
-    /** Set WebGL texture data from an image
+    /** Set WebGL texture data from an image, restores the active texture when done
      *  @param {WebGLTexture} texture
      *  @param {HTMLImageElement|HTMLCanvasElement|OffscreenCanvas} image
      *  @memberof WebGL */
@@ -2859,6 +2874,8 @@ declare module "littlejsengine" {
         defaultLineWidth: number;
         /** @property {number} - Default rounded rect corner radius for UI elements */
         defaultCornerRadius: number;
+        /** @property {number} - Default scale to use for fitting text to object */
+        defaultTextScale: number;
         /** @property {string} - Default font for UI elements */
         defaultFont: string;
         /** @property {Sound} - Default sound when interactive UI element is pressed */
@@ -2901,8 +2918,9 @@ declare module "littlejsengine" {
         *  @param {number}  [lineWidth=uiSystem.defaultLineWidth]
         *  @param {Color}   [lineColor=uiSystem.defaultLineColor]
         *  @param {string}  [align]
-        *  @param {string}  [font=uiSystem.defaultFont] */
-        drawText(text: string, pos: Vector2, size: Vector2, color?: Color, lineWidth?: number, lineColor?: Color, align?: string, font?: string): void;
+        *  @param {string}  [font=uiSystem.defaultFont]
+        *  @param {boolean} [applyMaxWidth=true] */
+        drawText(text: string, pos: Vector2, size: Vector2, color?: Color, lineWidth?: number, lineColor?: Color, align?: string, font?: string, applyMaxWidth?: boolean): void;
     }
     /**
      * UI Object - Base level object for all UI elements
@@ -2939,8 +2957,12 @@ declare module "littlejsengine" {
         cornerRadius: number;
         /** @property {string} - Font for this objecct */
         font: string;
+        /** @property {number} - Override for text width */
+        textWidth: any;
         /** @property {number} - Override for text height */
         textHeight: any;
+        /** @property {number} - Scale text to fit in the object */
+        textScale: number;
         /** @property {boolean} - Should this object be drawn */
         visible: boolean;
         /** @property {Array<UIObject>} - A list of this object's children */
@@ -2975,6 +2997,10 @@ declare module "littlejsengine" {
         render(): void;
         /** Special update when object is not visible */
         updateInvisible(): void;
+        /** Get the size for text with overrides and scale
+         *  @return {Vector2}
+         */
+        getTextSize(): Vector2;
         /** Called when the mouse enters the object */
         onEnter(): void;
         /** Called when the mouse leaves the object */