littlejsengine 1.14.5 → 1.14.8

package/dist/littlejs.d.ts

@@ -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}
@@ -1533,7 +1547,7 @@ declare module "littlejsengine" {
          *  @param {Vector2} pos
          *  @param {number}  [scale=.25]
          *  @param {boolean} [center]
-         *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D}[context=drawContext]
+         *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} [context=drawContext]
          */
         drawText(text: string, pos: Vector2, scale?: number, center?: boolean, context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D): void;
         /** Draw text on overlay canvas in world space using the image font
@@ -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 */
@@ -2364,7 +2379,7 @@ declare module "littlejsengine" {
          *  @param {TileInfo} [tileInfo]
          *  @param {Color}    [color=(1,1,1,1)]
          *  @param {number}   [angle=0]
-         *  @param {boolean}  [mirror=0] */
+         *  @param {boolean}  [mirror=false] */
         drawTile(pos: Vector2, size?: Vector2, tileInfo?: TileInfo, color?: Color, angle?: number, mirror?: boolean): void;
         /** Draw a rectangle onto the layer canvas in world space
          *  @param {Vector2} pos
@@ -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 */
@@ -2871,6 +2888,10 @@ declare module "littlejsengine" {
         uiObjects: any[];
         /** @property {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} - Context to render UI elements to */
         uiContext: CanvasRenderingContext2D;
+        /** @property {UIObject} - Top most object user is over */
+        hoverObject: any;
+        /** @property {UIObject} - Object user is currently interacting with */
+        activeObject: any;
         /** Draw a rectangle to the UI context
         *  @param {Vector2} pos
         *  @param {Vector2} size
@@ -2901,8 +2922,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
@@ -2921,6 +2943,8 @@ declare module "littlejsengine" {
         size: Vector2;
         /** @property {Color} - Color of the object */
         color: Color;
+        /** @property {Color} - Color of the object when active, uses color if undefined */
+        activeColor: any;
         /** @property {string} - Text for this ui object */
         text: any;
         /** @property {Color} - Color when disabled */
@@ -2939,15 +2963,19 @@ 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 */
         children: any[];
         /** @property {UIObject} - This object's parent, position is in parent space */
         parent: any;
-        /** @property {number} - Extra size added to make small buttons easier to touch on mobile devices */
+        /** @property {number} - Added size to make small buttons easier to touch on mobile devices */
         extraTouchSize: number;
         /** @property {Sound} - Sound when interactive element is pressed */
         soundPress: any;
@@ -2955,12 +2983,10 @@ declare module "littlejsengine" {
         soundRelease: any;
         /** @property {Sound} - Sound when interactive element is clicked */
         soundClick: any;
-        /** @property {boolean} - Is the mouse over this element */
-        mouseIsOver: boolean;
         /** @property {boolean} - Is this element interactive */
         interactive: boolean;
-        /** @property {boolean} - Is the mouse held on this element (was pressed while over and hasn't been released) */
-        mouseIsHeld: boolean;
+        /** @property {boolean} - Activate when dragged over with mouse held down */
+        dragActivate: boolean;
         /** Add a child UIObject to this object
          *  @param {UIObject} child
          */
@@ -2975,6 +3001,14 @@ 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;
+        /** @return {boolean} - Is the mouse hovering over this element */
+        isHoverObject(): boolean;
+        /** @return {boolean} - Is the mouse held onto this element */
+        isActiveObject(): boolean;
         /** Called when the mouse enters the object */
         onEnter(): void;
         /** Called when the mouse leaves the object */