@splinetool/runtime 1.10.16 → 1.10.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splinetool/runtime",
-  "version": "1.10.16",
+  "version": "1.10.18",
   "description": "Spline is a collaborative design platform for creating production-ready interactive experiences in multiple dimensions. © 2024 Spline, Inc.",
   "keywords": [
     "spline",

package/runtime.d.ts

@@ -6,6 +6,16 @@ declare module '@splinetool/runtime' {
 		};
 	};
 
+	export enum Easing {
+		LINEAR = 0,
+		EASE = 1,
+		EASE_IN = 2,
+		EASE_OUT = 3,
+		EASE_IN_OUT = 4,
+		CUBIC = 5,
+		SPRING = 6,
+	}
+
 	export type SplineEventName =
 		| 'mouseDown'
 		| 'mouseUp'
@@ -19,6 +29,42 @@ declare module '@splinetool/runtime' {
 		| 'collision'
 		| 'rendered';
 
+	export type TransitionChainParams = {
+		/**
+		 * When set, the transition will start from this state. If undefined (or not set) it will start from current state in the timeline.
+		 * When null it will start from the Base State / default state.
+		 */
+		from?: string | null;
+		to: string | null;
+		duration?: number;
+		delay?: number;
+	} & EasingData;
+
+	export type TransitionParams = TransitionChainParams & {
+		autoPlay?: boolean;
+	};
+
+	export type TransitionFactory = {
+		transition: (params: TransitionChainParams) => TransitionFactory;
+		/**
+		 * Starts the transition.
+		 */
+		play: () => TransitionFactory;
+		/**
+		 * Pauses the transition.
+		 */
+		pause: () => TransitionFactory;
+		/**
+		 * Resets the transition.
+		 */
+		reset: () => TransitionFactory;
+		/**
+		 * Seeks the transition to a specific time.
+		 * @param ms The time in milliseconds.
+		 */
+		seek: (ms: number) => TransitionFactory;
+	};
+
 	export type SPEObject = {
 		name: string;
 		uuid: string;
@@ -27,6 +73,11 @@ declare module '@splinetool/runtime' {
 		position: { x: number; y: number; z: number };
 		rotation: { x: number; y: number; z: number };
 		scale: { x: number; y: number; z: number };
+
+		/**
+		 * Gets or sets the object's current state from a given state name or id. Default state value is undefined.
+		 */
+		state: string | number | undefined;
 		/**
 		 * Triggers a Spline event.
 		 * Starts from firt state to last state.
@@ -40,6 +91,18 @@ declare module '@splinetool/runtime' {
 		 * @param {string} eventName String that matches Spline event's name
 		 */
 		emitEventReverse: (eventName: SplineEventName) => void;
+		/**
+		 * Hides the object.
+		 * Equivalent to object.visible = false
+		 */
+		hide: () => void;
+		/**
+		 * Hides the object.
+		 * Equivalent to object.visible = true
+		 */
+		show: () => void;
+
+		transition: (params: TransitionParams) => TransitionFactory;
 	};
 
 	export class Application {
@@ -231,5 +294,8 @@ declare module '@splinetool/runtime' {
 		 * @param url
 		 */
 		setUIWasmUrl(url: string): void;
+
+		pauseGameControls(): void {}
+		resumeGameControls(): void {}
 	}
 }