@turbowarp/types 0.0.13 → 0.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/types",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Type definitions for the Scratch VM and editor",
   "keywords": [
     "scratch"
@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/TurboWarp/types#readme",
   "devDependencies": {
-    "typedoc": "^0.25.12",
-    "typescript": "^4.7.4"
+    "typedoc": "^0.28.15",
+    "typescript": "^5.9.3"
   }
 }

package/types/events.d.ts

@@ -6,6 +6,7 @@ type EventEmitterCallback<Events, K extends keyof Events> = (...args: Events[K]
 
 declare class EventEmitter<Events> {
   on<K extends keyof Events>(event: K, callback: EventEmitterCallback<Events, K>): void;
+  addListener<K extends keyof Events>(event: K, callback: EventEmitterCallback<Events, K>): void;
   once<K extends keyof Events>(event: K, callback: EventEmitterCallback<Events, K>): void;
   off<K extends keyof Events>(event: K, callback: EventEmitterCallback<Events, K>): void;
   removeListener<K extends keyof Events>(event: K, callback: EventEmitterCallback<Events, K>): void;

package/types/scratch-audio.d.ts

@@ -14,7 +14,9 @@ declare namespace AudioEngine {
     mic: MediaStreamAudioSourceNode;
 
     /**
-     * @returns Loudness measured from 0-100.
+     * Get the current loudness of sound received by the microphone.
+     * Sound is measured in RMS and smoothed.
+     * @returns Loudness scaled 0 to 100, or -1 if there is no microphone input.
      */
     getLoudness(): number;
   }
@@ -32,7 +34,7 @@ declare namespace AudioEngine {
     target: Target;
     connect(target: Target): void;
     get name(): string;
-    get DEFAULT_VALUE(): string;
+    get DEFAULT_VALUE(): number;
     get _isPatch(): boolean;
     _set(value: number): void;
     set(value: number): void;
@@ -44,6 +46,10 @@ declare namespace AudioEngine {
   interface PitchEffect extends AbstractEffect {
     get name(): 'pitch';
     ratio: number;
+    /**
+     * The playback ratio is scaled so that a change of 10 in the effect value
+     * gives a change of 1 semitone in the ratio.
+     */
     getRatio(val: number): number;
     updatePlayer(soundPlayer: SoundPlayer): void;
     updatePlayers(soundPlayers: Record<string, SoundPlayer> | SoundPlayer[]): void;
@@ -101,6 +107,10 @@ declare namespace AudioEngine {
     isStarting: boolean;
     isPlaying: boolean;
     startingUntil: number;
+    playbackRate: number;
+    volumeEffect: VolumeEffect | null;
+    target: AudioEngine | Effect | EffectChain | null;
+    initialized: boolean;
     handleEvent(event: Event): void;
     onEnded(): void;
     _createSource(): void;
@@ -112,7 +122,7 @@ declare namespace AudioEngine {
     finished(): Promise<void>;
     setPlaybackRate(playbackRate: number): void;
     take(): SoundPlayer;
-    connect(connectable: AudioEngine | Effect | EffectChain): void;
+    connect(connectable: AudioEngine | Effect | EffectChain): SoundPlayer | undefined;
   }
 
   interface SoundBank {
@@ -144,7 +154,7 @@ declare namespace AudioEngine {
     playSound(target: Target, soundId: string): Promise<void>;
     setEffects(target: Target): void;
     stop(target: Target, soundId: string): void;
-    stopAllSounds(target: Target | '*'): void;
+    stopAllSounds(target?: Target | '*'): void;
     dispose(): void;
   }
 

package/types/scratch-blocks.d.ts

@@ -2,6 +2,9 @@
 // Project: https://github.com/LLK/scratch-blocks
 
 declare namespace ScratchBlocks {
+  const Blocks: Record<string, unknown>;
+  const Msg: Record<string, string>;
+
   class Block {
 
   }
@@ -178,6 +181,14 @@ declare namespace ScratchBlocks {
   interface BlocklyGlobal {
     getMainWorkspace(): Workspace | null;
   }
+
+  function prompt(
+    message: string,
+    defaultValue: string,
+    callback: (value: string | null) => void,
+    title?: string,
+    varType?: string
+  ): void;
 }
 
 declare const Blockly: ScratchBlocks.BlocklyGlobal | undefined;

package/types/scratch-render.d.ts

@@ -24,6 +24,7 @@ declare namespace RenderWebGL {
     Fisheye = 'fisheye',
     Whirl = 'whirl',
     Pixelate = 'pixelate',
+    Mosaic = 'mosaic',
     Brightness = 'brightness',
     Ghost = 'ghost'
   }
@@ -56,6 +57,11 @@ declare namespace RenderWebGL {
     snapToInt(): void;
   }
 
+  namespace Rectangle {
+    function intersect(a: Rectangle, b: Rectangle, result?: Rectangle): Rectangle;
+    function union(a: Rectangle, b: Rectangle, result?: Rectangle): Rectangle;
+  }
+
   /**
    * Suggested properties of a drawing region. Strictly, this can really be whatever you want it to be.
    */
@@ -79,7 +85,7 @@ declare namespace RenderWebGL {
     static DRAW_MODE: Record<DrawMode, DrawMode>;
 
     _gl: AnyWebGLContext;
-    _shaderCache: Record<DrawMode, Record<EffectMask, twgl.ProgramInfo[]>>;
+    _shaderCache: Record<DrawMode, twgl.ProgramInfo[]>;
     _buildShader(drawMode: DrawMode, effectMask: EffectMask): twgl.ProgramInfo;
     getShader(drawMode: DrawMode, effectMask: EffectMask): twgl.ProgramInfo;
   }
@@ -102,8 +108,8 @@ declare namespace RenderWebGL {
     colorAtNearest(textureCoordinate: twgl.V3, destination?: Uint8ClampedArray): Uint8ClampedArray;
     colorAtLinear(textureCoordinate: twgl.V3, destination?: Uint8ClampedArray): Uint8ClampedArray;
 
-    isTouchingNearest(textureCoordinate: twgl.V3): void;
-    isTouchingLinear(textureCoordinate: twgl.V3): void;
+    isTouchingNearest(textureCoordinate: twgl.V3): boolean;
+    isTouchingLinear(textureCoordinate: twgl.V3): boolean;
   }
 
   interface SkinEventMap {
@@ -131,7 +137,7 @@ declare namespace RenderWebGL {
       u_skinSize: [number, number];
       u_skin: WebGLTexture | null;
     };
-    getUniforms(): Skin['_uniforms'];
+    getUniforms(scale?: [number, number]): Skin['_uniforms'];
 
     _silhouette: Silhouette;
     updateSilhouette(): void;
@@ -148,11 +154,15 @@ declare namespace RenderWebGL {
 
     useNearest(scale: [number, number], drawable: Drawable): boolean;
 
-    getTexture(scale: [number, number]): WebGLTexture;
+    getTexture(scale?: [number, number]): WebGLTexture;
     _setTexture(image: BitmapData): void;
     setEmptyImageData(): void;
 
-    getFenceBounds(): Rectangle;
+    /**
+     * Get the bounds of the drawable for determining its fenced position.
+     * For compatibility with Scratch 2, we always use getAABB.
+     */
+    getFenceBounds(drawable: Drawable, result?: Rectangle): Rectangle;
 
     dispose(): void;
   }
@@ -201,15 +211,15 @@ declare namespace RenderWebGL {
     /**
      * Pen color in RGBA from 0-1.
      */
-    color4f: [number, number, number, number];
-    diameter: number;
+    color4f?: [number, number, number, number];
+    diameter?: number;
   }
 
   class PenSkin extends Skin {
     _renderer: RenderWebGL;
 
     _size: [number, number];
-    _framebuffer: WebGLFramebuffer;
+    _framebuffer: twgl.FrameBufferInfo;
     _silhouetteDirty: boolean;
     _silhouettePixels: Uint8Array;
     _silhouetteImageData: ImageData;
@@ -272,6 +282,7 @@ declare namespace RenderWebGL {
       width: number;
       height: number
     };
+    _text: string;
     _bubbleType: TextBubbleType;
     _pointsLeft: boolean;
     _textDirty: boolean;
@@ -324,7 +335,7 @@ declare namespace RenderWebGL {
 
     _scale: twgl.V3;
     get scale(): twgl.V3;
-    updateScale(scale: number): void;
+    updateScale(scale: [number, number]): void;
 
     _direction: number;
     updateDirection(direction: number): void;
@@ -361,7 +372,7 @@ declare namespace RenderWebGL {
     _convexHullPoints: Array<[number, number]>;
     _convexHullDirty: boolean;
     needsConvexHullPoints(): boolean;
-    setConvexHullDirty(): boolean;
+    setConvexHullDirty(): void;
     setConvexHullPoints(points: Array<[number, number]>): void;
 
     _transformedHullPoints: Array<[number, number]>;
@@ -380,6 +391,11 @@ declare namespace RenderWebGL {
     getFastBounds(result?: Rectangle): Rectangle;
 
     updateCPURenderAttributes(): void;
+    /**
+     * Check if the world position touches the skin.
+     * The caller is responsible for ensuring this drawable's inverse matrix & its skin's silhouette are up-to-date.
+     * @see updateCPURenderAttributes
+     */
     isTouching(textureCoordinate: twgl.V3): boolean;
     _isTouchingNearest(textureCoordinate: twgl.V3): boolean;
     _isTouchingLinear(textureCoordinate: twgl.V3): boolean;
@@ -556,7 +572,7 @@ declare class RenderWebGL extends EventEmitter<RenderWebGL.ScratchRenderEventMap
   pick(centerX: number, centerY: number, width?: number, height?: number, candidateIds?: number[]): number | -1 | false;
 
   extractDrawableScreenSpace(drawableId: number): {
-    data: ImageData;
+    imageData: ImageData;
     x: number;
     y: number;
     width: number;

package/types/scratch-storage.d.ts

@@ -17,7 +17,8 @@ declare namespace ScratchStorage {
     contentType: string;
     name: string;
     runtimeFormat: DataFormat;
-    immutable: true;
+    /** Indicates if the asset id is determined by the asset content. */
+    immutable: boolean;
   }
   namespace AssetType {
     const ImageBitmap: AssetType;
@@ -28,7 +29,7 @@ declare namespace ScratchStorage {
   }
 
   class Asset {
-    constructor(assetType: AssetType, assetId: string, dataFormat: DataFormat | null, data: ArrayBuffer, generateId?: boolean);
+    constructor(assetType: AssetType, assetId: string, dataFormat: DataFormat | null, data: Uint8Array, generateId?: boolean);
 
     assetType: AssetType;
 
@@ -39,7 +40,9 @@ declare namespace ScratchStorage {
      */
     assetId: string;
 
-    setData(data: ArrayBuffer, dataFormat: DataFormat, generateId?: boolean): void;
+    data: Uint8Array;
+
+    setData(data: Uint8Array, dataFormat: DataFormat, generateId?: boolean): void;
     encodeTextData(text: string, dataFormat: DataFormat, generateId?: boolean): void;
 
     decodeText(): string;
@@ -54,8 +57,9 @@ declare namespace ScratchStorage {
   type UrlFunction = (asset: Asset) => string;
 
   interface Helper {
+    parent: ScratchStorage;
     load(assetType: AssetType, assetId: string, dataFormat: DataFormat): Promise<Asset>;
-    store(assetType: AssetType, dataFormat: DataFormat, data: ArrayBuffer, assetId: string): Promise<unknown>;
+    store(assetType: AssetType, dataFormat: DataFormat, data: Uint8Array, assetId: string): Promise<unknown>;
   }
 }
 
@@ -72,14 +76,17 @@ declare class ScratchStorage {
    */
   get(assetId: string): ScratchStorage.Asset | null;
 
-  cache(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string): string;
+  cache(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: string): string;
 
   load(assetType: ScratchStorage.AssetType, assetId: string, dataFormat: ScratchStorage.DataFormat): Promise<ScratchStorage.Asset | null>;
 
-  store(assetType: ScratchStorage.Asset, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string): Promise<unknown>;
+  store(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: string): Promise<unknown>;
+
+  getDefaultAssetId(type: ScratchStorage.AssetType): string | undefined;
+  setDefaultAssetId(type: ScratchStorage.AssetType, id: string): void;
 
-  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: null, generateId: true): ScratchStorage.Asset;
-  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string, generateId?: boolean): ScratchStorage.Asset;
+  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: null, generateId: true): ScratchStorage.Asset;
+  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: string, generateId?: boolean): ScratchStorage.Asset;
 
   addWebStore(types: ScratchStorage.AssetType[], getFunction: ScratchStorage.UrlFunction, createFunction?: ScratchStorage.UrlFunction, updateFunction?: ScratchStorage.UrlFunction): void;