@rive-app/canvas-lite 2.16.0 → 2.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas-lite",
-  "version": "2.16.0",
+  "version": "2.17.0",
   "description": "A lite version of Rive's canvas based web api.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -495,6 +495,27 @@ export declare class Rive {
      * @returns the inputs for the named state machine
      */
     stateMachineInputs(name: string): StateMachineInput[];
+    private retrieveInputAtPath;
+    /**
+     * Set the boolean input with the provided name at the given path with value
+     * @param input the state machine input name
+     * @param value the value to set the input to
+     * @param path the path the input is located at an artboard level
+     */
+    setBooleanStateAtPath(inputName: string, value: boolean, path: string): void;
+    /**
+     * Set the number input with the provided name at the given path with value
+     * @param input the state machine input name
+     * @param value the value to set the input to
+     * @param path the path the input is located at an artboard level
+     */
+    setNumberStateAtPath(inputName: string, value: number, path: string): void;
+    /**
+     * Fire the trigger with the provided name at the given path
+     * @param input the state machine input name
+     * @param path the path the input is located at an artboard level
+     */
+    fireStateAtPath(inputName: string, path: string): void;
     get playingStateMachineNames(): string[];
     get playingAnimationNames(): string[];
     get pausedAnimationNames(): string[];

package/rive.js

@@ -2259,7 +2259,7 @@ Pc();
 /* 2 */
 /***/ ((module) => {
 
-module.exports = JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.16.0","description":"A lite version of Rive\'s canvas based web api.","main":"rive.js","homepage":"https://rive.app","repository":{"type":"git","url":"https://github.com/rive-app/rive-wasm/tree/master/js"},"keywords":["rive","animation"],"author":"Rive","contributors":["Luigi Rosso <luigi@rive.app> (https://rive.app)","Maxwell Talbot <max@rive.app> (https://rive.app)","Arthur Vivian <arthur@rive.app> (https://rive.app)","Umberto Sonnino <umberto@rive.app> (https://rive.app)","Matthew Sullivan <matt.j.sullivan@gmail.com> (mailto:matt.j.sullivan@gmail.com)"],"license":"MIT","files":["rive.js","rive.js.map","rive.wasm","rive_fallback.wasm","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
+module.exports = JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.17.0","description":"A lite version of Rive\'s canvas based web api.","main":"rive.js","homepage":"https://rive.app","repository":{"type":"git","url":"https://github.com/rive-app/rive-wasm/tree/master/js"},"keywords":["rive","animation"],"author":"Rive","contributors":["Luigi Rosso <luigi@rive.app> (https://rive.app)","Maxwell Talbot <max@rive.app> (https://rive.app)","Arthur Vivian <arthur@rive.app> (https://rive.app)","Umberto Sonnino <umberto@rive.app> (https://rive.app)","Matthew Sullivan <matt.j.sullivan@gmail.com> (mailto:matt.j.sullivan@gmail.com)"],"license":"MIT","files":["rive.js","rive.js.map","rive.wasm","rive_fallback.wasm","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
 
 /***/ }),
 /* 3 */
@@ -4650,6 +4650,73 @@ var Rive = /** @class */ (function () {
         var stateMachine = this.animator.stateMachines.find(function (m) { return m.name === name; });
         return stateMachine === null || stateMachine === void 0 ? void 0 : stateMachine.inputs;
     };
+    // Returns the input with the provided name at the given path
+    Rive.prototype.retrieveInputAtPath = function (name, path) {
+        if (!name) {
+            console.warn("No input name provided for path '".concat(path, "'"));
+            return;
+        }
+        if (!this.artboard) {
+            console.warn("Tried to access input: '".concat(name, "', at path: '").concat(path, "', but the Artboard is null"));
+            return;
+        }
+        var input = this.artboard.inputByPath(name, path);
+        if (!input) {
+            console.warn("Could not access an input with name: '".concat(name, "', at path:'").concat(path, "'"));
+            return;
+        }
+        return input;
+    };
+    /**
+     * Set the boolean input with the provided name at the given path with value
+     * @param input the state machine input name
+     * @param value the value to set the input to
+     * @param path the path the input is located at an artboard level
+     */
+    Rive.prototype.setBooleanStateAtPath = function (inputName, value, path) {
+        var input = this.retrieveInputAtPath(inputName, path);
+        if (!input)
+            return;
+        if (input.type === StateMachineInputType.Boolean) {
+            input.asBool().value = value;
+        }
+        else {
+            console.warn("Input with name: '".concat(inputName, "', at path:'").concat(path, "' is not a boolean"));
+        }
+    };
+    /**
+     * Set the number input with the provided name at the given path with value
+     * @param input the state machine input name
+     * @param value the value to set the input to
+     * @param path the path the input is located at an artboard level
+     */
+    Rive.prototype.setNumberStateAtPath = function (inputName, value, path) {
+        var input = this.retrieveInputAtPath(inputName, path);
+        if (!input)
+            return;
+        if (input.type === StateMachineInputType.Number) {
+            input.asNumber().value = value;
+        }
+        else {
+            console.warn("Input with name: '".concat(inputName, "', at path:'").concat(path, "' is not a number"));
+        }
+    };
+    /**
+     * Fire the trigger with the provided name at the given path
+     * @param input the state machine input name
+     * @param path the path the input is located at an artboard level
+     */
+    Rive.prototype.fireStateAtPath = function (inputName, path) {
+        var input = this.retrieveInputAtPath(inputName, path);
+        if (!input)
+            return;
+        if (input.type === StateMachineInputType.Trigger) {
+            input.asTrigger().fire();
+        }
+        else {
+            console.warn("Input with name: '".concat(inputName, "', at path:'").concat(path, "' is not a trigger"));
+        }
+    };
     Object.defineProperty(Rive.prototype, "playingStateMachineNames", {
         // Returns a list of playing machine names
         get: function () {