@splinetool/runtime 0.9.461 → 0.9.462

package/README.md

@@ -138,14 +138,40 @@ You might want to start the loading of `.splinecode` file before your code is lo
 
 ```js
 /*
-	When loading the Application, use the second
+	When loading the Application, use the third
 	param of the load function to make sure the browser
 	will use the preloaded file and not make another request
 */
-spline.load('https://prod.spline.design/6Wq1Q7YGyM-iab9i/scene.splinecode', {
-	credentials: 'include',
-	mode: 'no-cors',
-});
+spline.load(
+	'https://prod.spline.design/6Wq1Q7YGyM-iab9i/scene.splinecode',
+	undefined,
+	{
+		credentials: 'include',
+		mode: 'no-cors',
+	}
+);
+```
+
+### Updating scene variables
+
+If you setup variables in your Spline scene from the editor, you can change them from code either while loading the scene, of after it's loaded.
+Note that if in Spline editor you have multiple variables with the same name, only the first one will be updated, so make sure to give unique names to the variables you want to update.
+Also note that the values you pass to your variables will be casted into their original type (number, boolean or string).
+
+```js
+const spline = new Application(canvas);
+
+// Create an object describing the variables you want to update during load
+const myVariables = { myName: 'John', mySize: 350 };
+
+// And pass them as second parameter for the load function
+spline.load('.../scene.splinecode', myVariables);
+
+// Later you can update your variables again
+spline.setVariables({ myName: 'Paul', mySize: 100 });
+
+// Or change only one variable
+spline.setVariable('myName', 'Ringo');
 ```
 
 ## API
@@ -155,7 +181,7 @@ spline.load('https://prod.spline.design/6Wq1Q7YGyM-iab9i/scene.splinecode', {
 You can call all these different methods on the Spline `Application` instance.
 
 | Name                  | Type                                                                 | Description                                                                                                                         |
-| --------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| --------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------- |
 | `addEventListener`    | `(eventName: SplineEventName, cb: (e: SplineEvent) => void) => void` | Add an event listener for Spline events                                                                                             |
 | `removeEventListener` | `(eventName: SplineEventName, cb: (e: SplineEvent) => void) => void` | Remove an event listener for Spline events                                                                                          |
 | `emitEvent`           | `(eventName: SplineEventName, nameOrUuid: string) => void`           | Triggers a Spline event associated to an object with provided name or uuid in reverse order. Starts from first state to last state. |
@@ -164,6 +190,8 @@ You can call all these different methods on the Spline `Application` instance.
 | `findObjectByName`    | `(name: string) => SPEObject`                                        | Searches through scene's children and returns the first object with that name.                                                      |
 | `setZoom`             | `(zoom: number) => void`                                             | Sets the initial zoom of the scene.                                                                                                 |
 | `setSize`             | `(width: number, height:number) => void`                             | Sets the size of the application and canvas. When called, Spline will stop automatic size updates.                                  |
+| `setVariables`        | `(variables:Record<string, string                                    | number                                                                                                                              | boolean>) => void` | Updates values for passed variables by name |
+| `setVariable`         | `(name:string, value: string                                         | number                                                                                                                              | boolean) => void`  | Updates value for passed variable by name   |
 
 ### Spline Events