littlejsengine 1.18.24 → 1.18.26

package/README.md

@@ -23,6 +23,8 @@ The code is very clean and well documented with many examples to get you started
 
 *The Third Annual LittleJS Game Jam will take place From Oct 2 to Nov 2! Unleash your creativity and develop amazing games using the LittleJS game engine.*
 
+### 😼👍 [LittleJS + JS13k](https://github.com/KilledByAPixel/LittleJS/tree/js13k) - We made a special branch designed for size coding events like JS13k.
+
 <div align='center' markdown='1'>
 
 ## [Demos](https://killedbyapixel.github.io/LittleJS/examples) | [Arcade](https://killedbyapixel.github.io/LittleJSArcade) | [Docs](https://killedbyapixel.github.io/LittleJS/docs) | [FAQ](https://github.com/KilledByAPixel/LittleJS/blob/main/FAQ.md) | [Trailer](https://youtu.be/chuBzGjv7Ms) | [Discord](https://discord.gg/zb7hcGkyZe)
@@ -38,6 +40,7 @@ The code is very clean and well documented with many examples to get you started
 - Blazing fast WebGL2 + Canvas2D hybrid rendering system
 - Apply [Shadertoy](https://www.shadertoy.com) style shaders for post-processing effects
 - Robust particle effect system and [effect design tool](https://killedbyapixel.github.io/LittleJS/examples/particles/)
+- Load sprites and animations into texture sheets at runtime, or import [TexturePacker](https://www.codeandweb.com/texturepacker) and [Aseprite](https://www.aseprite.org) atlases
 - Optional 3D rendering with the [Three.js](https://threejs.org) plugin
 
 ### 🔊 Audio

package/dist/littlejs.d.ts

@@ -146,6 +146,17 @@ declare module "littlejsengine" {
      *  );
      *  @memberof Engine */
     export function engineInit(gameInit: GameInitCallback, gameUpdate: GameCallback, gameUpdatePost: GameCallback, gameRender: GameCallback, gameRenderPost: GameCallback, imageSources?: Array<string>, rootElement?: HTMLElement): Promise<void>;
+    /** Advance the engine by a number of frames
+     *  Requires setEngineManualStep(true) before engineInit
+     *  Respects paused exactly as the normal update loop does
+     *  @param {number} [frames] - number of engine update ticks, max 36000, each running one fixed update at timeScale 1
+     *  @example
+     *  setHeadlessMode(true);
+     *  setEngineManualStep(true);
+     *  await engineInit(gameInit, gameUpdate, gameUpdatePost, gameRender, gameRenderPost);
+     *  engineStep(600); // advance 10 seconds of game time
+     *  @memberof Engine */
+    export function engineStep(frames?: number): void;
     /** Update each engine object, remove destroyed objects, and update time
      * can be called manually if objects need to be updated outside of main loop
      *  @memberof Engine */
@@ -417,6 +428,12 @@ declare module "littlejsengine" {
      *  @default
      *  @memberof Settings */
     export let headlessMode: boolean;
+    /** Disables the automatic requestAnimationFrame loop so the engine only
+     *  advances when engineStep is called, for tests and frame-stepping tools
+     *  @type {boolean}
+     *  @default
+     *  @memberof Settings */
+    export let engineManualStep: boolean;
     /** Default size of tiles in pixels
      *  @type {Vector2}
      *  @default Vector2(16,16)
@@ -690,6 +707,11 @@ declare module "littlejsengine" {
      *  @param {boolean} headless
      *  @memberof Settings */
     export function setHeadlessMode(headless: boolean): void;
+    /** Set if the engine only advances when engineStep is called
+     *  Must be set before engineInit
+     *  @param {boolean} [enable]
+     *  @memberof Settings */
+    export function setEngineManualStep(enable?: boolean): void;
     /** Set if WebGL rendering is enabled
      *  @param {boolean} enable
      *  @memberof Settings */
@@ -1087,7 +1109,7 @@ declare module "littlejsengine" {
     export function shareURL(title: string, url: string, callback?: Function): void;
     /** Read save data from local storage
      *  @param {string} saveName - unique name for the game/save
-     *  @param {Object} [defaultSaveData] - default values for save
+     *  @param {Object} [defaultSaveData] - default values, result is {...default, ...loaded} so this must be an object
      *  @return {Object}
      *  @memberof Utilities */
     export function readSaveData(saveName: string, defaultSaveData?: any): any;