@turbowarp/types 0.0.7 → 0.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/types",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Type definitions for the Scratch VM and editor",
   "keywords": [
     "scratch"

package/tests/test-scratch-vm-extension.js

@@ -61,7 +61,6 @@
             }
           },
           {
-            opcode: 'button',
             blockType: Scratch.BlockType.BUTTON,
             func: 'MAKE_A_VARIABLE',
             text: 'button text'

package/tests/test-scratch-vm.ts

@@ -56,10 +56,17 @@ if (target) {
   target.on('EVENT_TARGET_VISUAL_CHANGE', (target) => {
     const id: string = target.id;
   });
+
+  runtime.on('STOP_FOR_TARGET', (t: VM.RenderedTarget) => {
+
+  });
 } else {
   const doesNotExist: undefined = target;
 }
 
+runtime._editingTarget as VM.Target;
+runtime.getEditingTarget() as VM.Target;
+
 const audioEngine = new AudioEngine();
 vm.attachAudioEngine(audioEngine);
 audioEngine.audioContext.suspend();

package/types/scratch-render.d.ts

@@ -11,14 +11,7 @@ declare namespace RenderWebGL {
 
   type BitmapData = ImageData | ImageBitmap | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement;
 
-  const enum LayerGroup {
-    // The renderer can be configured to use any strings as group names, but these are the groups
-    // that scratch-vm uses, listed in order.
-    Background = 'background',
-    Video = 'video',
-    Pen = 'pen',
-    Sprite = 'sprite'
-  }
+  type LayerGroup = 'background' | 'video' | 'pen' | 'sprite' | string;
 
   const enum UseGpuModes {
     Automatic = 'Automatic',
@@ -465,7 +458,7 @@ declare class RenderWebGL extends EventEmitter<RenderWebGL.ScratchRenderEventMap
   _nextDrawableId: number;
   _allDrawables: RenderWebGL.Drawable[];
 
-  createDrawable(group: string): void;
+  createDrawable(group: string): number;
   destroyDrawable(drawableID: number, group: RenderWebGL.LayerGroup): void;
 
   _allSkins: RenderWebGL.Skin[];
@@ -474,7 +467,7 @@ declare class RenderWebGL extends EventEmitter<RenderWebGL.ScratchRenderEventMap
   /**
    * @see {RenderWebGL.BitmapSkin.setBitmap}
    */
-  createBitmapSkin(image: RenderWebGL.BitmapData, bitmapResolution?: RenderWebGL.BitmapResolution, rotationCenter?: [number, number]): RenderWebGL.BitmapSkin;
+  createBitmapSkin(image: RenderWebGL.BitmapData, bitmapResolution?: RenderWebGL.BitmapResolution, rotationCenter?: [number, number]): number;
 
   /**
    * @see {RenderWebGL.BitmapSkin.setBitmap}
@@ -484,24 +477,24 @@ declare class RenderWebGL extends EventEmitter<RenderWebGL.ScratchRenderEventMap
   /**
    * @see {RenderWebGL.SVGSkin.setSVG}
    */
-  createSVGSkin(svgData: string, rotationCenter: [number, number]): RenderWebGL.SVGSkin;
+  createSVGSkin(svgData: string, rotationCenter?: [number, number]): number;
 
   /**
    * @see {RenderWebGL.SVGSkin.setSVG}
    */
-  updateSVGSkin(skinId: number, svgData: string, rotationCenter: [number, number]): void;
+  updateSVGSkin(skinId: number, svgData: string, rotationCenter?: [number, number]): void;
 
   /**
    * @see {RenderWebGL.TextBubbleSkin.setTextBubble}
    */
-  createTextSkin(type: RenderWebGL.TextBubbleType, text: string, pointsLeft: boolean): RenderWebGL.TextBubbleSkin;
+  createTextSkin(type: RenderWebGL.TextBubbleType, text: string, pointsLeft: boolean): number;
 
   /**
    * @see {RenderWebGL.TextBubbleSkin.setTextBubble}
    */
   updateTextSkin(skinId: number, type: RenderWebGL.TextBubbleType, text: string, pointsLeft: boolean): void;
 
-  createPenSkin(): RenderWebGL.PenSkin;
+  createPenSkin(): number;
 
   destroySkin(skinId: number): void;
 

package/types/scratch-vm-extension.d.ts

@@ -14,7 +14,6 @@ declare namespace Scratch {
 
   namespace BlockType {
     const BOOLEAN: 'Boolean';
-    /** @deprecated very incomplete and not useful yet */
     const BUTTON: 'button';
     const COMMAND: 'command';
     /** @deprecated does not work in compiler */
@@ -101,29 +100,31 @@ declare namespace Scratch {
   );
 
   interface AbstractBlock {
+    text: string | string[];
+    filter?: Array<'target' | 'sprite'>;
+  }
+  interface ExecutableBlock extends AbstractBlock {
     opcode: string;
     func?: string;
-    text: string | string[];
     arguments?: Record<string, Argument>;
     hideFromPalette?: boolean;
-    filter?: Array<'target' | 'sprite'>;
     blockIconURI?: string;
   }
-  interface BooleanBlock extends AbstractBlock {
+  interface BooleanBlock extends ExecutableBlock {
     blockType: 'Boolean';
   }
   interface ButtonBlock extends AbstractBlock {
     blockType: 'button';
     func: 'MAKE_A_LIST' | 'MAKE_A_PROCEDURE' | 'MAKE_A_VARIABLE';
   }
-  interface CommandBlock extends AbstractBlock {
+  interface CommandBlock extends ExecutableBlock {
     blockType: 'command';
     /**
      * Defaults to false.
      */
     isTerminal?: boolean;
   }
-  interface ConditionalBlock extends AbstractBlock {
+  interface ConditionalBlock extends ExecutableBlock {
     blockType: 'conditional';
     /**
      * Defaults to false.
@@ -134,7 +135,7 @@ declare namespace Scratch {
      */
     branchCount?: number;
   }
-  interface EventBlock extends AbstractBlock {
+  interface EventBlock extends ExecutableBlock {
     blockType: 'event';
     /**
      * This must be explicitly set to false, otherwise the block will not work.
@@ -146,7 +147,7 @@ declare namespace Scratch {
      */
     shouldRestartExistingThreads?: boolean;
   }
-  interface HatBlock extends AbstractBlock {
+  interface HatBlock extends ExecutableBlock {
     blockType: 'hat';
     /**
      * Defaults to true.
@@ -157,14 +158,14 @@ declare namespace Scratch {
      */
     shouldRestartExistingThreads?: boolean;
   }
-  interface ReporterBlock extends AbstractBlock {
+  interface ReporterBlock extends ExecutableBlock {
     blockType: 'reporter';
     /**
      * Defaults to false.
      */
     disableMonitor?: boolean;
   }
-  interface LoopBlock extends AbstractBlock {
+  interface LoopBlock extends ExecutableBlock {
     blockType: 'loop';
     /**
      * Defaults to false.

package/types/scratch-vm.d.ts

@@ -1030,7 +1030,12 @@ declare namespace VM {
   interface RuntimeEventMap extends RuntimeAndVirtualMachineEventMap {
     PROJECT_STOP_ALL: [];
 
-    STOP_FOR_TARGET: [BaseTarget, Thread | undefined];
+    STOP_FOR_TARGET: [
+      // Target whose scripts are being stopped
+      Target,
+      // Optional thread exception to keep running
+      Thread | undefined
+    ];
 
     PROJECT_LOADED: [];
 
@@ -1139,7 +1144,7 @@ declare namespace VM {
     getTargetById(targetId: string): Target | undefined;
 
     /**
-     * Find a sprite's original target (not a clone) using the sprite's name.
+     * Find a sprite's original target (not a clone or stage) using the sprite's name.
      * Returns undefined if the target doesn't exist.
      */
     getSpriteTargetByName(spriteName: string): Target | undefined;
@@ -1308,6 +1313,7 @@ declare namespace VM {
 
     emitProjectChanged(): void;
 
+    _editingTarget: Target | null;
     getEditingTarget(): Target | null;
 
     setEditingTarget(target: Target): void;