@cesdk/cesdk-js 1.4.2 → 1.5.0-alpha.0

package/BlockAPI.d.ts

@@ -339,6 +339,13 @@ export default class BlockAPI {
    */
   destroy(id: DesignBlockId): void;
 
+  /**
+   * Check if a block is valid. A block becomes invalid once it has been destroyed.
+   * @param id The block to query.
+   * @returns True, if the block is valid.
+   */
+  isValid(id: DesignBlockId): boolean;
+
   /**
    * Query a block's parent.
    * @param id The block to query.

package/EventAPI.d.ts

@@ -0,0 +1,19 @@
+type DesignBlockId = number;
+
+export type BlockEvent = {
+  block: DesignBlockId;
+  type: 'Created' | 'Updated' | 'Destroyed';
+};
+
+export default class EventAPI {
+  /**
+   * @brief Subscribe to block life-cycle events.
+   * @param blocks A list of blocks to filter events by. If the list is empty, events for every block are sent.
+   * @param callback The event callback. Events are bundled and sent at the end of each engine update.
+   * @returns A method to unsubscribe.
+   */
+  subscribe(
+    blocks: DesignBlockId[],
+    callback: (events: BlockEvent[]) => void
+  ): () => void;
+}

package/api.d.ts

@@ -1,6 +1,7 @@
 import BlockAPI from './BlockAPI';
 import SceneAPI from './SceneAPI';
 import VariableAPI from './VariableAPI';
+import EventAPI from './EventAPI';
 
 export default class API {
   block: BlockAPI;
@@ -8,4 +9,6 @@ export default class API {
   scene: SceneAPI;
 
   variable: VariableAPI;
+
+  event: EventAPI;
 }