@dreamcomposer/engine-types 0.0.16 → 0.0.18

package/from-engine/DisplayLoadingUiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever the loading ui should be displayed.
+ */
+export interface DisplayLoadingUiMessage
+  extends FromEngineMessage<"display-loading-ui"> {
+  payload: {};
+}

package/from-engine/HideLoadingUiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever the loading ui should be hidden.
+ */
+export interface HideLoadingUiMessage
+  extends FromEngineMessage<"hide-loading-ui"> {
+  payload: {};
+}

package/package.json

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

package/post-messages.d.ts

@@ -38,6 +38,8 @@ import { SetUseFramingAnimation } from "./to-engine/SetUseFramingAnimation";
 import { SetSkeletonStatesMessage } from "./to-engine/SetSkeletonStatesMessage";
 import { RecenterSkeletonObjectsMessage } from "./to-engine/RecenterSkeletonObjectsMessage";
 import { SetShadowPlaneVisibilityMessage } from "./to-engine/SetShadowPlaneVisibilityMessage";
+import { DisplayLoadingUiMessage } from "./from-engine/DisplayLoadingUiMessage";
+import { HideLoadingUiMessage } from "./from-engine/HideLoadingUiMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -63,8 +65,10 @@ export interface ToEngineMessage<Channel> {
 export type FromEnginePostMessage =
   | AckMessage
   | CanvasImageUrlMessage
+  | DisplayLoadingUiMessage
   | EngineReadyMessage
   | HideGuiMessage
+  | HideLoadingUiMessage
   | KeyDownMessage
   | PointerEventMessage
   | SetEffectsSettingsAckMessage

package/to-engine/SetCutoutTextureMessage.d.ts

@@ -9,8 +9,9 @@ import { ToEngineMessage } from "../post-messages";
 export interface SetCutoutTextureMessage
   extends ToEngineMessage<"set-cutout-texture"> {
   /**
-   * The cutout mask in the PNG format or an empty string to reset it (i.e.,
-   * setting a texture with no cutouts).
+   * The cutout mask in the PNG format. Can either be a blob or a URL to the
+   * cutout texture. An empty string is used to reset it (i.e., setting a
+   * texture with no cutouts).
    */
-  payload: Blob | "";
+  payload: Blob | string | "";
 }

package/to-engine/SetSkeletonStatesMessage.ts

@@ -4,7 +4,8 @@ import { ToEngineMessage } from "../post-messages";
 /**
  * A message to set the mesh skeleton states
  */
-export interface SetSkeletonStatesMessage extends ToEngineMessage<"set-skeleton-states"> {
+export interface SetSkeletonStatesMessage
+  extends ToEngineMessage<"set-skeleton-states"> {
   payload: {
     /**
      * The skeleton states. The key is the name of the skeleton from the mesh.