@dreamcomposer/engine-types 0.0.34 → 0.0.36

package/from-engine/KeyDownEventMessage.d.ts

@@ -0,0 +1,14 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Whenever a key is pressed while the iframe is focused, this event is
+ * dispatched. This can be useful since the embedder of the iframe does not
+ * receive key down events that happen inside the iframe.
+ */
+export interface KeyDownEventMessage
+  extends FromEngineMessage<"key-down-event"> {
+  /**
+   * The event data for the pressed key
+   */
+  payload: KeyboardEventInit;
+}

package/from-engine/KeyUpEventMessage.d.ts

@@ -0,0 +1,13 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Whenever a key is released while the iframe is focused, this event is
+ * dispatched. This can be useful since the embedder of the iframe does not
+ * receive key down events that happen inside the iframe.
+ */
+export interface KeyUpEventMessage extends FromEngineMessage<"key-up-event"> {
+  /**
+   * The event data for the released key
+   */
+  payload: KeyboardEventInit;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamcomposer/engine-types",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "The type definitions for messages from and to the engine",
   "license": "UNLICENSED",
   "private": false,

package/post-messages.d.ts

@@ -36,6 +36,8 @@ import { RecenterSkeletonObjectsMessage } from "./to-engine/RecenterSkeletonObje
 import { SetShadowPlaneVisibilityMessage } from "./to-engine/SetShadowPlaneVisibilityMessage";
 import { DisplayLoadingUiMessage } from "./from-engine/DisplayLoadingUiMessage";
 import { HideLoadingUiMessage } from "./from-engine/HideLoadingUiMessage";
+import { KeyDownEventMessage } from "./from-engine/KeyDownEventMessage";
+import { KeyUpEventMessage } from "./from-engine/KeyUpEventMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -66,6 +68,8 @@ export type FromEnginePostMessage =
   | HideGuiMessage
   | HideLoadingUiMessage
   | KeyDownMessage
+  | KeyDownEventMessage
+  | KeyUpEventMessage
   | PointerEventMessage
   | SetLoadingProgressMessage;
 

package/to-engine/SetStageMappingsMessage.d.ts

@@ -12,33 +12,40 @@ export interface SetStageMappingsMessage
      */
     [stageName: string]: {
       /**
-       * The x position where the mapping begings.
+       * The layer texture mapping
        *
-       * This is not a pixel value but a percentage (i.e., a value between `0`
-       * and `1`).
+       * If not provided only the surface material is visible by defaulting to `{x: -1, y: -1, width: 1, height: 1}`.
        */
-      x: number;
-      /**
-       * The y position where the mapping begings.
-       *
-       * This is not a pixel value but a percentage (i.e., a value between `0`
-       * and `1`).
-       */
-      y: number;
-      /**
-       * The with of the mapping.
-       *
-       * This is not a pixel value but a percentage (i.e., a value between `0`
-       * and `1`).
-       */
-      width: number;
-      /**
-       * The height of the mapping.
-       *
-       * This is not a pixel value but a percentage (i.e., a value between `0`
-       * and `1`).
-       */
-      height: number;
+      uvMapping?: {
+        /**
+         * The x position where the mapping begings.
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        x: number;
+        /**
+         * The y position where the mapping begings.
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        y: number;
+        /**
+         * The with of the mapping.
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        width: number;
+        /**
+         * The height of the mapping.
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        height: number;
+      };
       /**
        * The rotation of the mapping in degrees.
        *