babylonjs-toolkit 9.6.2 → 9.9.1

package/README.md

@@ -1,13 +1,11 @@
 # Classic Edition
 The <a href="https://www.babylontoolkit.com">Babylon Toolkit</a> is a runtime library extension for BabylonJS development that provides modern programming mechanics with a familiar Unity like scripting model to fast track native web game development.
 
-**We recommend using the modern ES6 supported edition**
-
-<a href="https://www.npmjs.com/package/@babylonjs-toolkit/next">Next Edition (ES6)</a>
+<a href="https://github.com/babylontoolkit/StarterAssets">Demo React Project (TSX)</a>
 <br/>
 <a href="https://github.com/BabylonJS/BabylonToolkit/tree/master/Runtime">Browser Library (CDN)</a>
 <br/>
-<a href="https://github.com/codewrxai/Starter-Project">Demo React Project (TSX)</a>
+<a href="https://www.npmjs.com/package/@babylonjs-toolkit/next">Next Edition (ES6)</a>
 
 
 ## Basic Installation
@@ -15,10 +13,9 @@ The <a href="https://www.babylontoolkit.com">Babylon Toolkit</a> is a runtime li
 npm install babylonjs-toolkit
 ```
 
-
 ## Default Installation (UMD)
 ```bash
-npm install babylonjs babylonjs-gui babylonjs-loaders babylonjs-materials babylonjs-toolkit
+npm install babylonjs babylonjs-gui babylonjs-addons babylonjs-loaders babylonjs-materials babylonjs-inspector babylonjs-toolkit
 ```
 
 * Global Import Side Effects (main.ts)
@@ -41,23 +38,22 @@ import 'babylonjs-toolkit';
     "babylonjs-toolkit"
 ]
 ```
+### Vite Configuration (UMD)
 
-Note: The **BABYLON** and **TOOLKIT** namespaces are globally accessible. Navigation is now bundled within the toolkit.
-
+The Vite bundle services behave differently in devmode than production. To preserve some required classes during devmode, these `exclude` and `include` settings are strongly recommended in your vite.config.js settings file.
 
-## Navigation Mesh And Pathfinding ([Navigation](https://github.com/MackeyK24/babylon-navigation-mesh))
-
-Access Navigation from the babylon-toolkit:
-```
-TOOLKIT.Navigation
-```
-
-Or access Navigation from the global window:
-```
-window.Navigation
+```json
+  optimizeDeps: {
+    exclude: ["babylonjs-inspector"],
+    include: mode === 'development' ? [
+      "babylonjs",
+      "babylonjs-gui",
+      "babylonjs-addons",
+      "babylonjs-loaders",
+      "babylonjs-materials",
+      "babylonjs-toolkit",
+    ] : [],
+  },
 ```
 
-Or access Navigation using shorthand globals:
-```
-Navigation;
-```
+Note: The **BABYLON** and **TOOLKIT** namespaces are globally accessible. Navigation is now bundled within the toolkit.

package/lib/babylon.toolkit.d.ts

@@ -7,7 +7,7 @@ declare namespace TOOLKIT {
     * @class SceneManager - All rights reserved (c) 2024 Mackey Kinard
     */
     class SceneManager {
-        /** Gets the toolkit framework version string (9.6.2 - R1) */
+        /** Gets the toolkit framework version string (9.9.1 - R1) */
         static get Version(): string;
         /** Gets the toolkit framework copyright notice */
         static get Copyright(): string;
@@ -25,6 +25,10 @@ declare namespace TOOLKIT {
         static RenderLoopReady: boolean;
         /** Pauses the main page render loop */
         static PauseRenderLoop: boolean;
+        /** Defines whether the toolkit scene simulation is currently playing (true) or paused for editing (false). Defaults to true so shipped runtimes are unaffected. The editor sets this false for a static edit mode and true to enter live play mode. Use SetScenePlaying() to also freeze/resume the physics world. */
+        static ScenePlaying: boolean;
+        /** Cached physics engine time step used to resume the simulation after a pause. */
+        private static PhysicsTimeStep;
         /** The webgl render context has been lost flag */
         static LostRenderContext: boolean;
         /** Set the preload auto update progress flag */
@@ -259,6 +263,15 @@ declare namespace TOOLKIT {
         static GetTimeMilliseconds(): number;
         /** Get the delta time animation ratio for 60 fps */
         static GetAnimationRatio(scene: BABYLON.Scene): number;
+        /**
+         * Sets whether the toolkit scene simulation is playing (true) or paused for editing (false).
+         * When paused: the script component life-cycle (awake/start/update/late/step/fixed) is halted and the
+         * physics world simulation is frozen (time step set to 0). When resumed: the physics time step is
+         * restored and the game time baseline is reset. Shipped runtimes default to playing so are unaffected.
+         * @param playing defines whether the scene simulation should run.
+         * @param scene defines the optional target scene (defaults to the last created scene).
+         */
+        static SetScenePlaying(playing: boolean, scene?: BABYLON.Scene): void;
         /** Run a function on the next render loop. */
         static RunOnce(scene: BABYLON.Scene, func: () => void, timeout?: number): void;
         /** Disposes entire scene and release all resources */