littlejsengine 1.11.2 → 1.11.5

package/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "Open index.html",
+            "file": "c:\\dev\\FrankGames\\html5\\LittleJS\\LittleJS\\shortExamples\\index.html"
+        }
+    ]
+}

package/README.md

@@ -18,9 +18,9 @@ LittleJS is a fast, lightweight, and fully open source HTML5 game engine designe
 Its small footprint is packed with a comprehensive feature set including hybrid rendering, physics, particles, sound, and input handling.
 The code is clean and well documented with some fun examples to get you started right away. Choo-Choo!
 
-### 🚀 Join the First Ever LittleJS Game Jam
+### 🚀 Join the Second Annual LittleJS Game Jam
 
-*The LittleJS Game Jam will take place From Nov 11 to Dec 12! 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)*
+*The 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">
 
@@ -62,7 +62,7 @@ LittleJS is a small but powerful game engine with many features and no dependenc
 
 - Compatible with all modern web browsers and on mobile devices
 - Support for TypeScript and Modules with example projects for both
-- Ideal for size coding competitions like [js13kGames](https://js13kgames.com/), [starter project builds to a 7KB zip](https://killedbyapixel.github.io/LittleJS/examples/js13k)
+- Ideal for size coding competitions like [js13kGames](https://js13kgames.com/), [starter project builds to a 7KB zip](https://github.com/KilledByAPixel/LittleJS/tree/js13k)
 - Builds to an executable with [Electron](https://www.electronjs.org/) for distribution on Windows, macOS, and Linux
 - Open Source with the [MIT license](https://github.com/KilledByAPixel/LittleJS/blob/main/LICENSE) so it can be used for anything you want forever
 
@@ -84,6 +84,7 @@ To get started download the latest LittleJS package from GitHub or install via n
 This is because web browsers just have protection from loading local files. 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.
 
 - Learn how to make a simple game from scratch with [The Breakout Tutorial.](https://github.com/KilledByAPixel/LittleJS/tree/main/examples/breakoutTutorial)
+- [Make a ski game with LittleJS](https://eoinmcgrath.com/little-ski/tutorial.html) - Check out this tutorial by eoinmcg that shows how to make a pixel art style game.
 - [LittleJS Engine Quick Reference Sheet](https://github.com/KilledByAPixel/LittleJS/blob/main/reference.md) - This cheat sheet can help you get started.
 - [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.
 - Join our vibrant community on [Discord](https://discord.gg/zb7hcGkyZe) to get help, share your projects, and collaborate with others!
@@ -122,21 +123,18 @@ Debug builds of LittleJS have a special menu that can be opened by pressing the
 
 Here are a few of the amazing games people made using LittleJS...
 
-- [Space Huggers](https://github.com/KilledByAPixel/SpaceHuggers) - Original js13k game with source code by [KilledByAPixel](https://frankforce.com/)
-- [Undergrowth](https://undergrowth.squidband.uk/) - An interactive music videogame for the band Squid by [KilledByAPixel](https://frankforce.com/)
-- [The Way of the Dodo](https://js13kgames.com/2024/games/the-way-of-the-dodo) - Single button platformer by [repsej](https://github.com/repsej)
-- [Wendol Village](https://js13kgames.com/2024/games/wendol-village) - Warcraft-like RTS game by [sanojian](https://github.com/sanojian)
-- [Dead Again](https://js13kgames.com/entries/dead-again) - Top down survial horror by [sanojian & repsej](https://github.com/sanojian/js13k_2022)
-- [Isletopia](https://store.steampowered.com/app/1861260/Isletopia) - Relaxing strategy game of greenifying barren islands by [Gamex Studio](https://x.com/gamesgamex)
-- [Hel's Trial](https://js13kgames.com/entries/hels-trial) - Turn based RPG by [Sebastian Dorn](https://github.com/sebadorn/js13k-2022-death)
-- [Bit Butcher](https://js13kgames.com/entries/bit-butcher) - Survival crafting game by [Deathray Games](https://github.com/deathraygames/bit-butcher)
-- [Necrotic Commander](https://js13kgames.com/entries/necrotic-commander) - Tower defense game by [Daniel Jeffery](https://github.com/d-jeffery/NecroticCommander)
-- [Boxing up Bamboo](https://patrickgh3.itch.io/boxing-up-bamboo) - Challenging puzzle game by [Patrick Traynor](https://cwpat.me/about)
-- [Samurai Sam](https://dev.js13kgames.com/2023/games/samurai-sam) - Fruit Ninja inspired rhythm game by [John Edvard](https://reitgames.com)
-- [brrr!](https://snowfrog.itch.io/brrr) - Base defense and shooting game by [Snowfrog](https://www.snowfrog.dev/)
-- [Wands of Triskaidekai](https://js13kgames.com/2024/games/wands-of-triskaidekai) - Platformer with experimental gameplay by [gregwoodsfrontier](https://github.com/gregwoodsfrontier)
-- [Data Warrior: 13kb limit](https://js13kgames.com/2024/games/data-warrior-13kb-limit) - Vampire Survivors-like game by [rndD](https://github.com/rndD)
-- [Unblock](https://js13kgames.com/games/unblock) - Retro style space shooter by [Isaac Benitez](https://github.com/isacben)
+- [Space Huggers](https://www.newgrounds.com/portal/view/819609) - Rogulike platformer shoot-em-up game with procedural levels. by [KilledByAPixel](https://frankforce.com/)
+- [Undergrowth](https://undergrowth.squidband.uk/) - An interactive music videogame for the band Squid. by [KilledByAPixel](https://frankforce.com/)
+- [The Way of the Dodo](https://js13kgames.com/2024/games/the-way-of-the-dodo) - Single button platformer. JS13k 5th place winner! by [repsej](https://github.com/repsej)
+- [204Snake!](https://www.newgrounds.com/portal/view/960100) - A puzzle game that combines 2048 with snake. LittleJS Jam 1st place winner! by [Sodoj](https://sodoj.itch.io/) and [Shai-P](https://shai-p.itch.io/)
+- [GATOR](https://www.newgrounds.com/portal/view/960757) - Retro platformer shooter game where you rescue animals. LittleJS Jam 2nd place winner! by [eoinmcg](https://eoinmcg.itch.io/)
+- [A Hedgehog's search](https://willsm1111.itch.io/a-hedgehogs-search) - Adventure game staring a hedgehog. LittleJS Jam 3rd place winner! by [willsm1111](https://willsm1111.itch.io/)
+- [Wendol Village](https://js13kgames.com/2024/games/wendol-village) - Warcraft inspired RTS game. by [sanojian](https://github.com/sanojian)
+- [Dead Again](https://js13kgames.com/entries/dead-again) - Top down survial horror. by [sanojian & repsej](https://github.com/sanojian/js13k_2022)
+- [Isletopia](https://store.steampowered.com/app/1861260/Isletopia) - Relaxing strategy game of greenifying barren islands. by [Gamex Studio](https://x.com/gamesgamex)
+- [Tetrimals](https://nixn.itch.io/tetrimals) - A puzzle game mixing Tetris with animals. by [nixn](https://nixn.itch.io/)
+- [Watch the Pups](https://ma5a.itch.io/watch-the-pups) - The aim of the game is to take care of some puppies. by [masa](https://ma5a.itch.io/)
+- [LittleJS Game Jam Results](https://itch.io/jam/littlejs-game-jam/results) - Check out all the games from the first LittleJS Game Jam!
 
 ![LittleJS Logo](examples/favicon.png)
 

package/dist/littlejs.d.ts

@@ -272,7 +272,7 @@ declare module "littlejsengine" {
      *  @default
      *  @memberof Settings */
     export let enablePhysicsSolver: boolean;
-    /** Default object mass for collision calcuations (how heavy objects are)
+    /** Default object mass for collision calculations (how heavy objects are)
      *  @type {Number}
      *  @default
      *  @memberof Settings */
@@ -436,7 +436,7 @@ declare module "littlejsengine" {
      *  @param {Boolean} show
      *  @memberof Settings */
     export function setShowSplashScreen(show: boolean): void;
-    /** Set to disalbe rendering, audio, and input for servers
+    /** Set to disable rendering, audio, and input for servers
      *  @param {Boolean} headless
      *  @memberof Settings */
     export function setHeadlessMode(headless: boolean): void;
@@ -460,7 +460,7 @@ declare module "littlejsengine" {
      *  @param {Boolean} enable
      *  @memberof Settings */
     export function setEnablePhysicsSolver(enable: boolean): void;
-    /** Set default object mass for collison calcuations
+    /** Set default object mass for collision calculations
      *  @param {Number} mass
      *  @memberof Settings */
     export function setObjectDefaultMass(mass: number): void;
@@ -516,7 +516,7 @@ declare module "littlejsengine" {
      *  @param {Boolean} analog
      *  @memberof Settings */
     export function setTouchGamepadAnalog(analog: boolean): void;
-    /** Set size of virutal gamepad for touch devices in pixels
+    /** Set size of virtual gamepad for touch devices in pixels
      *  @param {Number} size
      *  @memberof Settings */
     export function setTouchGamepadSize(size: number): void;
@@ -586,7 +586,7 @@ declare module "littlejsengine" {
      *  @default Math.PI
      *  @memberof Utilities */
     export const PI: number;
-    /** Returns absoulte value of value passed in
+    /** Returns absolute value of value passed in
      *  @param {Number} value
      *  @return {Number}
      *  @memberof Utilities */
@@ -614,7 +614,7 @@ declare module "littlejsengine" {
      *  @return {Number}
      *  @memberof Utilities */
     export function mod(dividend: number, divisor?: number): number;
-    /** Clamps the value beween max and min
+    /** Clamps the value between max and min
      *  @param {Number} value
      *  @param {Number} [min]
      *  @param {Number} [max]
@@ -856,11 +856,11 @@ declare module "littlejsengine" {
          * @param {Number} angle
          * @return {Vector2} */
         rotate(angle: number): Vector2;
-        /** Set the integer direction of this vector, corrosponding to multiples of 90 degree rotation (0-3)
+        /** Set the integer direction of this vector, corresponding to multiples of 90 degree rotation (0-3)
          * @param {Number} [direction]
          * @param {Number} [length] */
         setDirection(direction?: number, length?: number): Vector2;
-        /** Returns the integer direction of this vector, corrosponding to multiples of 90 degree rotation (0-3)
+        /** Returns the integer direction of this vector, corresponding to multiples of 90 degree rotation (0-3)
          * @return {Number} */
         direction(): number;
         /** Returns a copy of this vector that has been inverted
@@ -989,7 +989,7 @@ declare module "littlejsengine" {
      * a.set(3);             // sets the timer to 3 seconds
      *
      * let b = new Timer(1); // creates a timer with 1 second left
-     * b.unset();            // unsets the timer
+     * b.unset();            // unset the timer
      */
     export class Timer {
         /** Create a timer object set time passed in
@@ -1109,9 +1109,9 @@ declare module "littlejsengine" {
      *  @memberof Utilities */
     export const MAGENTA: Color;
     /** Array containing texture info for batch rendering system
-     *  @type {Array}
+     *  @type {Array<TextureInfo>}
      *  @memberof Draw */
-    export let textureInfos: any[];
+    export let textureInfos: Array<TextureInfo>;
     /**
      * Create a tile info object using a grid based system
      * - This can take vecs or floats for easier use and conversion
@@ -1302,12 +1302,6 @@ declare module "littlejsengine" {
      *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} [context=mainContext]
      *  @memberof Draw */
     export function drawCanvas2D(pos: Vector2, size: Vector2, angle: number, mirror: boolean, drawFunction: Function, screenSpace?: boolean, context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D): void;
-    /** Enable normal or additive blend mode
-     *  @param {Boolean} [additive]
-     *  @param {Boolean} [useWebGL=glEnable]
-     *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} [context=mainContext]
-     *  @memberof Draw */
-    export function setBlendMode(additive?: boolean, useWebGL?: boolean, context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D): void;
     /** Draw text on main canvas in world space
      *  Automatically splits new lines into rows
      *  @param {String}  text
@@ -1349,6 +1343,16 @@ declare module "littlejsengine" {
      *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} [context=overlayContext]
      *  @memberof Draw */
     export function drawTextScreen(text: string, pos: Vector2, size?: number, color?: Color, lineWidth?: number, lineColor?: Color, textAlign?: CanvasTextAlign, font?: string, maxWidth?: number, context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D): void;
+    /** Enable normal or additive blend mode
+     *  @param {Boolean} [additive]
+     *  @param {Boolean} [useWebGL=glEnable]
+     *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} [context=mainContext]
+     *  @memberof Draw */
+    export function setBlendMode(additive?: boolean, useWebGL?: boolean, context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D): void;
+    /** Combines all LittleJS canvases onto the main canvas and clears them
+     *  This is necessary for things like saving a screenshot
+     *  @memberof Draw */
+    export function combineCanvases(): void;
     export let engineFontImage: any;
     /**
      * Font Image Object - Draw text on a 2D canvas by using characters in an image
@@ -1357,7 +1361,7 @@ declare module "littlejsengine" {
      * - You can also use fonts from the main tile sheet
      * @example
      * // use built in font
-     * const font = new ImageFont;
+     * const font = new FontImage;
      *
      * // draw text
      * font.drawTextScreen("LittleJS\nHello World!", vec2(200, 50));
@@ -1393,9 +1397,13 @@ declare module "littlejsengine" {
      *  @return {Boolean}
      *  @memberof Draw */
     export function isFullscreen(): boolean;
-    /** Toggle fullsceen mode
+    /** Toggle fullscreen mode
      *  @memberof Draw */
     export function toggleFullscreen(): void;
+    /** Set the cursor style
+     *  @param {String}  cursorStyle - CSS cursor style (auto, none, crosshair, etc)
+     *  @memberof Draw */
+    export function setCursor(cursorStyle?: string): void;
     /** Get the camera's visible area in world space
      *  @return {Vector2}
      *  @memberof Draw */
@@ -1425,7 +1433,7 @@ declare module "littlejsengine" {
      *  @return {WebGLShader}
      *  @memberof WebGL */
     export function glCompileShader(source: string, type: number): WebGLShader;
-    /** Draw any sprites still in the buffer, copy to main canvas and clear
+    /** Draw any sprites still in the buffer and copy to main canvas
      *  @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} context
      *  @param {Boolean} [forceDraw]
      *  @memberof WebGL */
@@ -1463,11 +1471,14 @@ declare module "littlejsengine" {
      *  @param {WebGLTexture} texture
      *  @memberof WebGL */
     export function glSetTexture(texture: WebGLTexture): void;
-    /** Set antialiasing for webgl canvas
+    /** Set anti-aliasing for webgl canvas
      *  @param {Boolean} [antialias]
      *  @memberof WebGL */
     export function glSetAntialias(antialias?: boolean): void;
-    /** Shoule webgl be setup with antialiasing, must be set before calling engineInit
+    /** Clear the canvas and setup the viewport
+     *  @memberof WebGL */
+    export function glClearCanvas(): void;
+    /** Should webgl be setup with anti-aliasing? must be set before calling engineInit
      *  @type {Boolean}
      *  @memberof WebGL */
     export let glAntialias: boolean;
@@ -1892,7 +1903,7 @@ declare module "littlejsengine" {
         worldToLocalVector(vec: Vector2): Vector2;
         /** Called to check if a tile collision should be resolved
          *  @param {Number}  tileData - the value of the tile at the position
-         *  @param {Vector2} pos      - tile where the collision occured
+         *  @param {Vector2} pos      - tile where the collision occurred
          *  @return {Boolean}         - true if the collision should be resolved */
         collideWithTile(tileData: number, pos: Vector2): boolean;
         /** Called to check if a object collision should be resolved
@@ -1926,7 +1937,7 @@ declare module "littlejsengine" {
          *  @param {Boolean} [collideTiles]        - Does it collide with the tile collision?
          *  @param {Boolean} [collideRaycast]      - Does it collide with raycasts? */
         setCollision(collideSolidObjects?: boolean, isSolid?: boolean, collideTiles?: boolean, collideRaycast?: boolean): void;
-        /** Returns string containg info about this object for debugging
+        /** Returns string containing info about this object for debugging
          *  @return {String} */
         toString(): string;
         /** Render debug info for this object  */
@@ -2049,12 +2060,12 @@ declare module "littlejsengine" {
         redrawEnd(): void;
         /** Draw the tile at a given position in the tile grid
          *  This can be used to clear out tiles when they are destroyed
-         *  Tiles can also be redrawn if isinde a redrawStart/End block
+         *  Tiles can also be redrawn if inside a redrawStart/End block
          *  @param {Vector2} layerPos
          *  @param {Boolean} [clear] - should the old tile be cleared out
          */
         drawTileData(layerPos: Vector2, clear?: boolean): void;
-        /** Draw directly to the 2D canvas in world space (bipass webgl)
+        /** Draw directly to the 2D canvas in world space (bypass webgl)
          *  @param {Vector2}  pos
          *  @param {Vector2}  size
          *  @param {Number}   angle
@@ -2098,7 +2109,7 @@ declare module "littlejsengine" {
      * let pos = vec2(2,3);
      * let particleEmitter = new ParticleEmitter
      * (
-     *     pos, 0, 1, 0, 500, PI,      // pos, angle, emitSize, emitTime, emitRate, emiteCone
+     *     pos, 0, 1, 0, 500, PI,      // pos, angle, emitSize, emitTime, emitRate, emitCone
      *     tile(0, 16),                // tileInfo
      *     rgb(1,1,1),   rgb(0,0,0),   // colorStartA, colorStartB
      *     rgb(1,1,1,0), rgb(0,0,0,0), // colorEndA, colorEndB
@@ -2132,7 +2143,7 @@ declare module "littlejsengine" {
          *  @param {Number} [fadeRate]          - How quick to fade particles at start/end in percent of life
          *  @param {Number} [randomness]    - Apply extra randomness percent
          *  @param {Boolean} [collideTiles] - Do particles collide against tiles
-         *  @param {Boolean} [additive]     - Should particles use addtive blend
+         *  @param {Boolean} [additive]     - Should particles use additive blend
          *  @param {Boolean} [randomColorLinear] - Should color be randomized linearly or across each component
          *  @param {Number} [renderOrder] - Render order for particles (additive is above other stuff by default)
          *  @param {Boolean}  [localSpace] - Should it be in local space of emitter (world space is default)
@@ -2172,11 +2183,11 @@ declare module "littlejsengine" {
         fadeRate: number;
         /** @property {Number} - Apply extra randomness percent */
         randomness: number;
-        /** @property {Boolean} - Should particles use addtive blend */
+        /** @property {Boolean} - Should particles use additive blend */
         additive: boolean;
         /** @property {Boolean} - Should it be in local space of emitter */
         localSpace: boolean;
-        /** @property {Number} - If non zero the partile is drawn as a trail, stretched in the drection of velocity */
+        /** @property {Number} - If non zero the particle is drawn as a trail, stretched in the direction of velocity */
         trailScale: number;
         /** @property {Function}   - Callback when particle is destroyed */
         particleDestroyCallback: any;