@babylonjs-toolkit/next 9.1.0 → 9.5.0

package/README.md

@@ -1,15 +1,10 @@
 # ESNext 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.
 
-<a href="https://www.npmjs.com/package/babylonjs-toolkit">Classic Edition (UMD)</a>
-<br/>
-<a href="https://github.com/BabylonJS/BabylonToolkit/tree/master/Runtime">Browser Library (CDN)</a>
-<br/>
 <a href="https://github.com/MackeyK24/ES6-StarterAssets">Demo React Project (TSX)</a>
 <br/>
 <a href="https://github.com/MackeyK24/NJS-StarterAssets">Next.js React Project (TSX)</a>
 
-
 ## Basic Installation
 ```bash
 npm install @babylonjs-toolkit/next

package/lib/scenemanager.d.ts

@@ -34,7 +34,7 @@ import { Sound } from '@babylonjs/core/Audio/sound';
 import { Skeleton } from '@babylonjs/core/Bones/skeleton';
 import { Control } from '@babylonjs/gui/2D/controls/control';
 import { Effect } from '@babylonjs/core/Materials/effect';
-import { PhysicsBody, IPhysicsEnabledObject, PhysicsShape, PhysicsShapeCapsule, PhysicsRaycastResult, PhysicsMotionType, IRaycastQuery, ShapeCastResult, PhysicsShapeSphere, PhysicsShapeMesh, PhysicsShapeConvexHull, PhysicsShapeBox, PhysicsShapeCylinder } from '@babylonjs/core/Physics';
+import { PhysicsBody, IPhysicsEnabledObject, PhysicsShape, PhysicsShapeCapsule, PhysicsRaycastResult, PhysicsMotionType, IRaycastQuery, ShapeCastResult, PhysicsShapeMesh, PhysicsShapeConvexHull, PhysicsShapeBox, PhysicsShapeSphere, PhysicsShapeCylinder } from '@babylonjs/core/Physics';
 import { HavokPlugin } from '@babylonjs/core/Physics/v2/Plugins/havokPlugin';
 import { GLTFLoader } from '@babylonjs/loaders/glTF/2.0/glTFLoader';
 import { IScene, INode, IMaterial, IAnimation, IMesh } from '@babylonjs/loaders/glTF/2.0/glTFLoaderInterfaces';
@@ -121,8 +121,18 @@ export declare class SceneManager {
     static get EventBus(): GlobalMessageBus;
     static get PlaygroundCdn(): string;
     static get PlaygroundRepo(): string;
-    static InitializePlayground(engine: Engine | WebGPUEngine | AbstractEngine, options?: IRuntimeOptions): Promise<void>;
-    static InitializeRuntime(engine: Engine | WebGPUEngine | AbstractEngine, options?: IRuntimeOptions): Promise<void>;
+    static InitializePlayground(engine: Engine | WebGPUEngine | AbstractEngine, options?: IRuntimeOptions, scene?: Scene, inputOptions?: {
+        contextMenu?: boolean;
+        pointerLock?: boolean;
+        preventDefault?: boolean;
+        useCapture?: boolean;
+    }): Promise<void>;
+    static InitializeRuntime(engine: Engine | WebGPUEngine | AbstractEngine, options?: IRuntimeOptions, scene?: Scene, inputOptions?: {
+        contextMenu?: boolean;
+        pointerLock?: boolean;
+        preventDefault?: boolean;
+        useCapture?: boolean;
+    }): Promise<void>;
     static InitializeSceneLoaderPlugin(): void;
     static LoadRuntimeAssets(assetsManager: AssetsManager, requiredFilenames: string[], readyHandler: () => void, maxTimeout?: number, debugMode?: boolean): Promise<void>;
     static ShowLoadingScreen(engine: Engine | WebGPUEngine | AbstractEngine, hideLoadingUIWithEngine?: boolean, defaultLoadingUIMarginTop?: string): void;
@@ -134,9 +144,6 @@ export declare class SceneManager {
     private static SceneLoaderPropertyBag;
     private static SceneLoaderHandledFlag;
     static SetOnSceneReadyHandler(filenames: string[], handler: () => void, timeout?: number, debug?: boolean): void;
-    static NavigateTo(scene: Scene, route: string, options?: any, useWindowLocation?: boolean): void;
-    static SetReactNavigationHook(scene: Scene, navigateToFunction: any): void;
-    static DeleteReactNavigationHook(scene: Scene): void;
     private static SceneParsingEnabled;
     static EnableSceneParsing(enabled: boolean): void;
     static IsSceneParsingEnabled(): boolean;
@@ -434,6 +441,9 @@ export declare abstract class ScriptComponent {
     private static ParseAutoProperties;
     private static UnpackObjectProperty;
 }
+export declare abstract class GameModeController extends ScriptComponent {
+    constructor(transform: TransformNode, scene: Scene, properties?: any, alias?: string);
+}
 export declare enum System {
     Deg2Rad,
     Rad2Deg,
@@ -620,6 +630,7 @@ export declare class UserInputOptions {
     static EnableBabylonRotation: boolean;
 }
 export interface IRuntimeOptions {
+    enableUserInput?: boolean;
     hardwareScalingLevel?: number;
     initSceneFileLoaders?: boolean;
     loadAsyncRuntimeLibs?: boolean;
@@ -2816,44 +2827,6 @@ export declare class btRaycastVehicle {
     isArcadeHandBrakeActive: boolean;
     isArcadeWheelSkidActive: boolean;
     isArcadeYawAssistActive: boolean;
-    arcadeYawAssistDebugLogEnabled: boolean;
-    arcadeYawAssistDebugLogIntervalFrames: number;
-    arcadeYawAssistDebugLogEdgeEvents: boolean;
-    arcadeHandbrakeKickStrengthDegPerSec: number;
-    arcadeHandbrakeKickFrames: number;
-    arcadeHandbrakeYawAuthority: number;
-    arcadeHandbrakeMaxYawRateDegPerSec: number;
-    arcadeHandbrakeReferenceSpeedKmh: number;
-    arcadeHandbrakeSpeedGateEnabled: boolean;
-    arcadeHandbrakeLowSpeedShape: number;
-    arcadeHandbrakeDirectYawEnabled: boolean;
-    arcadeHandbrakeDirectYawDegPerSec: number;
-    arcadeHandbrakeDirectYawDurationMs: number;
-    arcadeHandbrakeDirectYawFadeMs: number;
-    arcadeDonutDirectYawEnabled: boolean;
-    arcadeDonutDirectYawDegPerSec: number;
-    arcadeDonutDirectYawDurationMs: number;
-    arcadeDonutDirectYawFadeMs: number;
-    arcadeHandbrakeMaxSlideAngleDeg: number;
-    arcadeHandbrakeCounterSteerClampEnabled: boolean;
-    arcadeHandbrakeCounterSteerYawThresholdDegPerSec: number;
-    arcadeHandbrakeClampReleaseFadeMs: number;
-    arcadeHandbrakeSteerSlewLimitEnabled: boolean;
-    arcadeHandbrakeSteerSlewLimitDegPerSec: number;
-    private _wasArcadeHandBrakeActive;
-    private _wasArcadeYawAssistApplyingForce;
-    private _handbrakeKickJzRemaining;
-    private _handbrakeKickFramesRemaining;
-    private _arcadeHandbrakeLatchedDriveSign;
-    private _arcadeHandbrakeHoldElapsedSec;
-    private _arcadeHandbrakeSlewedSteerRad;
-    private _arcadeHandbrakeClampReleaseFadeSec;
-    private _arcadeDonutHoldElapsedSec;
-    private _arcadeYawAssistDebugFrameCounter;
-    private _arcadeYawAssistLastKickRad;
-    private _arcadeYawAssistLastIaddPerWheel;
-    private _arcadeYawAssistLastClampScalar;
-    private _arcadeYawAssistLastLeverSum;
     burnoutFrictionFloor: number;
     frictionRestoreSpeed: number;
     arcadeBurnoutWheelSpinGain: number;
@@ -2866,16 +2839,20 @@ export declare class btRaycastVehicle {
     arcadeWheelSpinMaxAngularVelocity: number;
     arcadeStationaryBurnoutWheelSpinGain: number;
     arcadeStationaryBurnoutMinAngularVelocity: number;
+    arcadeHandbrakeYawCapMultiplier: number;
+    arcadeBurnoutYawCapMultiplier: number;
+    arcadeDonutYawCapMultiplier: number;
     arcadeSkidFadeInSpeed: number;
     arcadeSkidFadeOutSpeed: number;
-    arcadeYawCapMultiplier: number;
     wheelAtRestSpeedThresholdKmh: number;
-    wheelSpinDebugLogEnabled: boolean;
-    wheelSpinDebugLogIntervalFrames: number;
-    private _wheelSpinDebugLogCounter;
-    private _postHandbrakeLogFrames;
-    private _postHandbrakeLogCounter;
-    private _wasAnyArcadeModeActive;
+    arcadeHandbrakeAssistEnabled: boolean;
+    currentSteeringInput: number;
+    arcadeDonutDirectYawEnabled: boolean;
+    arcadeDonutDirectYawDegPerSec: number;
+    arcadeDonutDirectYawDurationMs: number;
+    arcadeDonutDirectYawFadeMs: number;
+    private _arcadeDonutHoldElapsedSec;
+    private _arcadeDonutDirectionSign;
     private _forwardWS;
     private _axle;
     private _forwardImpulse;
@@ -2883,6 +2860,11 @@ export declare class btRaycastVehicle {
     private _arcadeSkidInfo;
     private _arcadePreviousWheelSpin;
     sideFrictionStiffness: number;
+    arcadeSideSlipSaturationEnabled: boolean;
+    arcadeSideSlipPeakDeg: number;
+    arcadeSideSlipFalloffDeg: number;
+    arcadeSideSlipFalloffFactor: number;
+    arcadeSideSlipMinSpeedMps: number;
     private _chassisMass;
     private _chassisInvMass;
     private _chassisTransform;
@@ -2957,6 +2939,8 @@ export declare class btRaycastVehicle {
     private applyTrackConnectionAndDownforce;
     updateVehicle(step: number): void;
     private updateSuspension;
+    private getSteeringAuthorityInput;
+    private getSteeringMagnitude;
     private applyEasyDonutYawAssist;
     private applyHandbrakeYawAssist;
     private resolveWheelSpinDirection;
@@ -3267,20 +3251,16 @@ export declare class RaycastVehicle {
     isArcadeYawAssistActive(): boolean;
     getArcadeSteeringAssist(): number;
     setArcadeSteeringAssist(value: number): void;
+    getArcadeDonutDirectYawEnabled(): boolean;
+    setArcadeDonutDirectYawEnabled(value: boolean): void;
     getArcadeDonutDirectYawDegPerSec(): number;
     setArcadeDonutDirectYawDegPerSec(value: number): void;
-    getArcadeHandbrakeDirectYawDegPerSec(): number;
-    setArcadeHandbrakeDirectYawDegPerSec(value: number): void;
-    getArcadeHandbrakeMaxSlideAngleDeg(): number;
-    setArcadeHandbrakeMaxSlideAngleDeg(value: number): void;
-    getArcadeHandbrakeBicycleYawAuthority(): number;
-    setArcadeHandbrakeBicycleYawAuthority(value: number): void;
-    getArcadeHandbrakeMaxYawRateDegPerSec(): number;
-    setArcadeHandbrakeMaxYawRateDegPerSec(value: number): void;
-    getArcadeHandbrakeReferenceSpeedKmh(): number;
-    setArcadeHandbrakeReferenceSpeedKmh(value: number): void;
-    getArcadeHandbrakeKickStrengthDegPerSec(): number;
-    setArcadeHandbrakeKickStrengthDegPerSec(value: number): void;
+    getArcadeHandbrakeYawCapMultiplier(): number;
+    setArcadeHandbrakeYawCapMultiplier(value: number): void;
+    getArcadeBurnoutYawCapMultiplier(): number;
+    setArcadeBurnoutYawCapMultiplier(value: number): void;
+    getArcadeDonutYawCapMultiplier(): number;
+    setArcadeDonutYawCapMultiplier(value: number): void;
     getArcadeBurnoutActive(): boolean;
     setArcadeBurnoutActive(active: boolean): void;
     getArcadeDonutActive(): boolean;
@@ -3302,9 +3282,6 @@ export declare class RaycastVehicle {
     getNaturalWheelSlip(wheelIndex: number): boolean;
     getWheelAtRestSpeedThresholdKmh(): number;
     setWheelAtRestSpeedThresholdKmh(value: number): void;
-    setWheelSpinDebugLogEnabled(enabled: boolean): void;
-    getWheelSpinDebugLogEnabled(): boolean;
-    setWheelSpinDebugLogIntervalFrames(frames: number): void;
     updateWheelInformation(): void;
     protected lockedWheelInformation(wheel: number): boolean;
     protected deleteWheelInformation(): void;