@dreamcomposer/engine-types 0.0.35 → 0.0.37

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.35",
+  "version": "0.0.37",
   "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/SetGeometryMessage.d.ts

@@ -81,6 +81,14 @@ export interface SetGeometryMessage extends ToEngineMessage<"set-geometry"> {
           axes?: [number, number];
         };
       };
+      /**
+       * Overrides object use to alter properties of the geometry such as material parameters.
+       * Not necessary but usually used to alter the look of static objects in the geometry.
+       */
+      overrides?: Array<{
+        target: string[];
+        data: Record<string, unknown> | Record<string, unknown>[];
+      }>;
     };
   };
 }