Class VM

constructor

• new VM(): VM

  Returns VM

_dragTarget

assets

editingTarget

extensionManager

renderer

runtime

addBackdrop

• addBackdrop(md5ext: string, costume?: Costume): Promise<void>

  Parameters

  • md5ext: string
  • Optionalcostume: Costume

  Returns Promise<void>

addCostume

• addCostume(
      md5ext: string,
      costume?: Partial<Costume>,
      targetId?: string,
      version?: 2,
  ): Promise<void>

  Parameters

  • md5ext: string
  • Optionalcostume: Partial<Costume>
  • OptionaltargetId: string
  • Optionalversion: 2

  Returns Promise<void>

addCostumeFromLibrary

• addCostumeFromLibrary(md5ext: string, costume: Partial<Costume>): Promise<void>

  Parameters

  • md5ext: string
  • costume: Partial<Costume>

  Returns Promise<void>

addSound

• addSound(sound: Partial<VM.Sound>, targetId?: string): Promise<void>

  Parameters

  • sound: Partial<VM.Sound>
  • OptionaltargetId: string

  Returns Promise<void>

addSprite

• addSprite(
      data: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>,
  ): Promise<void>

  Loads a sprite from a compressed .sprite2 or .sprite3 or JSON.

  Parameters

  • data: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>

  Returns Promise<void>

attachAudioEngine

• attachAudioEngine(audioEngine: AudioEngine): void

  Parameters

  • audioEngine: AudioEngine

  Returns void

  See

attachRenderer

• attachRenderer(renderer: RenderWebGL): void

  Parameters

  • renderer: RenderWebGL

  Returns void

  See

attachStorage

• attachStorage(storage: ScratchStorage): void

  Parameters

  • storage: ScratchStorage

  Returns void

  See

attachV2BitmapAdapter

• attachV2BitmapAdapter(bitmapAdapter: BitmapAdapter): void

  Parameters

  • bitmapAdapter: BitmapAdapter

  Returns void

  See

attachV2SVGAdapter

• attachV2SVGAdapter(): void

  Returns void

  Deprecated

  Does nothing.

blockListener

• blockListener(e: unknown): void

  Handle a Blockly event for the current editing target.

  Parameters

  • e: unknown

  Returns void

clear

• clear(): void

  Remove everything from the VM.

  Returns void

clearFlyoutBlocks

• clearFlyoutBlocks(): void

  Delete all of the flyout blocks.

  Returns void

configureScratchLinkSocketFactory

• configureScratchLinkSocketFactory(factory: Function): void

  Allow VM consumer to configure the ScratchLink socket creator.

  Parameters

  • factory: Function

  Returns void

connectPeripheral

• connectPeripheral(extensionID: string, peripheralId: number): void

  Parameters

  • extensionID: string
  • peripheralId: number

  Returns void

  See

deleteCostume

• deleteCostume(costumeIndex: number): (() => void) | null

  Deletes the costume at a given index int he editing target.

  Parameters

  • costumeIndex: number

  Returns (() => void) | null

  If a costume was deleted, returns a function to undo the deletion.

deleteSound

• deleteSound(soundIndex: number): (() => void) | null

  Deletes the sound at a given index in the editing target.

  Parameters

  • soundIndex: number

  Returns (() => void) | null

  If a sound was deleted, returns a function to undo the deletion.

deleteSprite

• deleteSprite(targetId: string): (() => void) | null

  Deletes the target with the given ID and any of its clones.

  Parameters

  • targetId: string

  Returns (() => void) | null

  If a sprite was deleted, returns a function to undo the deletion.

deserializeProject

• deserializeProject(json: object, zip?: JSZip): Promise<void>

  Parameters

  • json: object
  • Optionalzip: JSZip

  Returns Promise<void>

disconnectPeripheral

• disconnectPeripheral(extensionID: string): void

  Parameters

  • extensionID: string

  Returns void

  See

downloadProjectId

• downloadProjectId(id: string | number): Promise<void>

  Load a project usings its ID from scratch.mit.edu.

  Parameters

  • id: string | number

  Returns Promise<void>

duplicateCostume

• duplicateCostume(costumeIndex: number): Promise<void>

  Parameters

  • costumeIndex: number

  Returns Promise<void>

duplicateSound

• duplicateSound(soundIndex: number): Promise<void>

  Parameters

  • soundIndex: number

  Returns Promise<void>

duplicateSprite

• duplicateSprite(targetId: string): Promise<void>

  Parameters

  • targetId: string

  Returns Promise<void>

emitTargetsUpdate

• emitTargetsUpdate(shouldTriggerProjectChange?: boolean): void

  Emit a targetsUpdate event about the current target information.

  Parameters

  • OptionalshouldTriggerProjectChange: boolean

    Whether a PROJECT_CHANGED event should be emitted. Defaults to true.

  Returns void

emitWorkspaceUpdate

• emitWorkspaceUpdate(): void

  Emit a workspaceUpdate event.

  Returns void

exportSprite

• exportSprite(targetId: string): Promise<Blob>

  Export a specific sprite to a compressed sprite3 file.

  Parameters

  • targetId: string

    The ID of the target

  Returns Promise<Blob>

• exportSprite(targetId: string, zipType: string): Promise<unknown>

  Export a specific sprite to a compressed sprite3 file.

  Parameters

  • targetId: string

    The ID of the target

  • zipType: string

  Returns Promise<unknown>

flyoutBlockListener

• flyoutBlockListener(e: unknown): void

  Handle a Blockly event for the flyout.

  Parameters

  • e: unknown

  Returns void

fromJSON

• fromJSON(
      input: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>,
  ): Promise<void>

  Parameters

  • input: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>

  Returns Promise<void>

  Deprecated

  See

getCostume

• getCostume(costumeIndex: number): string | null

  Gets the string representation of a costume. For an SVG costume, returns the text. For a PNG or JPG costume, returns a data URL. If costume doesn't exist, returns null.

  Parameters

  • costumeIndex: number

  Returns string | null

getLocale

• getLocale(): string

  Get the current locale for the VM.

  Returns string

getPeripheralIsConnected

• getPeripheralIsConnected(extensionID: string): boolean

  Parameters

  • extensionID: string

  Returns boolean

  See

getPlaygroundData

• getPlaygroundData(): void

  Get data for playground. Data comes back in an emitted playgroundData event.

  Returns void

getSoundBuffer

• getSoundBuffer(soundIndex: number): AudioBuffer | null

  Parameters

  • soundIndex: number

  Returns AudioBuffer | null

getTargetIdForDrawableId

• getTargetIdForDrawableId(drawableId: number): string | null

  Parameters

  • drawableId: number

  Returns string | null

getVariableValue

• getVariableValue(targetId: string, variableId: string): VariableValue | null

  Parameters

  • targetId: string
  • variableId: string

  Returns VariableValue | null

greenFlag

• greenFlag(): void

  Returns void

  See

installTargets

• installTargets(
      targets: RenderedTarget[],
      extensions: ImportedExtensionsInfo,
      wholeProject: boolean,
  ): Promise<void>

  Parameters

  • targets: RenderedTarget[]
  • extensions: ImportedExtensionsInfo
  • wholeProject: boolean

  Returns Promise<void>

loadProject

• loadProject(
      input: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>,
  ): Promise<void>

  Load a project.

  Parameters

  • input: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>

    Compressed sb, sb2, sb3 or sb2 project.json or sb3 project.json.

  Returns Promise<void>

monitorBlockListener

• monitorBlockListener(e: unknown): void

  Handle a Blockly event for the flyout to be passed to the monitor container.

  Parameters

  • e: unknown

  Returns void

postIOData

• postIOData(device: "cloud", data: CloudData): void

  Parameters

  • device: "cloud"
  • data: CloudData

  Returns void

• postIOData(device: "keyboard", data: KeyboardData): void

  Parameters

  • device: "keyboard"
  • data: KeyboardData

  Returns void

• postIOData(device: "mouse", data: MouseData): void

  Parameters

  • device: "mouse"
  • data: MouseData

  Returns void

• postIOData(device: "mouseWheel", data: MouseWheelData): void

  Parameters

  • device: "mouseWheel"
  • data: MouseWheelData

  Returns void

• postIOData(device: "userData", data: UserDataData): void

  Parameters

  • device: "userData"
  • data: UserDataData

  Returns void

• postIOData(device: "video", data: VideoData): void

  Parameters

  • device: "video"
  • data: VideoData

  Returns void

postSpriteInfo

• postSpriteInfo(spriteInfo: PostedSpriteInfo): void

  Post sprite info to the target that's being dragged, otherwise the editing target.

  Parameters

  • spriteInfo: PostedSpriteInfo

  Returns void

  See

quit

• quit(): void

  Returns void

  See

refreshWorkspace

• refreshWorkspace(): void

  Returns void

renameCostume

• renameCostume(costumeIndex: number, newName: string): void

  Parameters

  • costumeIndex: number
  • newName: string

  Returns void

renameSound

• renameSound(soundIndex: number, newName: string): void

  Parameters

  • soundIndex: number
  • newName: string

  Returns void

renameSprite

• renameSprite(targetId: string, newName: string): void

  Parameters

  • targetId: string
  • newName: string

  Returns void

reorderCostume

• reorderCostume(
      targetId: string,
      costumeIndex: number,
      newIndex: number,
  ): boolean

  Parameters

  • targetId: string
  • costumeIndex: number
  • newIndex: number

  Returns boolean

reorderSound

• reorderSound(targetId: string, soundIndex: number, newIndex: number): boolean

  Parameters

  • targetId: string
  • soundIndex: number
  • newIndex: number

  Returns boolean

reorderTarget

• reorderTarget(targetId: string, newIndex: number): boolean

  Parameters

  • targetId: string
  • newIndex: number

  Returns boolean

saveProjectSb3

• saveProjectSb3(): Promise<Blob>

  the project to a compressed sb3 file.

  Returns Promise<Blob>

scanForPeripheral

• scanForPeripheral(extensionID: string): void

  Parameters

  • extensionID: string

  Returns void

  See

setCloudProvider

• setCloudProvider(cloudProvider: CloudProvider): void

  Parameters

  • cloudProvider: CloudProvider

  Returns void

setCompatibilityMode

• setCompatibilityMode(compatibilityMode: boolean): void

  Changes whether the runtime is in "compatibility mode" (true by default) Compatibility mode sets the runtime's framerate to 30 FPS. Disabling it sets the framerate to 60 FPS.

  Parameters

  • compatibilityMode: boolean

  Returns void

setEditingTarget

• setEditingTarget(targetId: string): void

  Change the editing target. If a target with the ID doesn't exist, silently does nothing.

  Parameters

  • targetId: string

  Returns void

  See

setLocale

• setLocale(locale: string, messages: Record<string, string>): Promise<void[]>

  Set the current locale and builtin messages for the VM. Resolves once all blocks have been updated for the new locale.

  Parameters

  • locale: string
  • messages: Record<string, string>

  Returns Promise<void[]>

setTurboMode

• setTurboMode(turboMode: boolean): void

  Changes whether the runtime is in turbo mode or not. Emits either TURBO_MODE_ON or TURBO_MODE_OFF.

  Parameters

  • turboMode: boolean

    whether turbo mode should be enabled

  Returns void

setVariableValue

• setVariableValue(
      targetId: string,
      variableId: string,
      value: VariableValue,
  ): boolean

  Updates the value of a variable. Returns true if the target and variable were successfully found and updated, otherwise null.

  Parameters

  • targetId: string
  • variableId: string
  • value: VariableValue

  Returns boolean

setVideoProvider

• setVideoProvider(videoProvider: VideoProvider): void

  Parameters

  • videoProvider: VideoProvider

  Returns void

shareBlocksToTarget

• shareBlocksToTarget(
      blocks: VM.Block[],
      targetId: string,
      fromTargetId?: string,
  ): Promise<void>

  Returns a promise that resolves when all required extensions have been imported.

  Parameters

  • blocks: VM.Block[]
  • targetId: string
  • OptionalfromTargetId: string

  Returns Promise<void>

shareCostumeToTarget

• shareCostumeToTarget(costumeIndex: number, targetId: string): Promise<void>

  Share a costume from the editing target to another target.

  Parameters

  • costumeIndex: number
  • targetId: string

  Returns Promise<void>

shareSoundToTarget

• shareSoundToTarget(soundIndex: number, targetId: string): Promise<void>

  Share a sound from the editing target to another target.

  Parameters

  • soundIndex: number
  • targetId: string

  Returns Promise<void>

start

• start(): void

  Returns void

  See

startDrag

• startDrag(targetId: string): void

  Parameters

  • targetId: string

  Returns void

stopAll

• stopAll(): void

  Returns void

  See

stopDrag

• stopDrag(targetId: string): void

  Parameters

  • targetId: string

  Returns void

toJSON

• toJSON(targetId?: string): string

  Parameters

  • OptionaltargetId: string

  Returns string

updateBitmap

• updateBitmap(
      costumeIndex: number,
      bitmap: ImageData,
      rotationCenterX: number,
      rotationCenterY: number,
      bitmapResolution: number,
  ): void

  Parameters

  • costumeIndex: number
  • bitmap: ImageData
  • rotationCenterX: number
  • rotationCenterY: number
  • bitmapResolution: number

  Returns void

updateSoundBuffer

• updateSoundBuffer(
      soundIndex: number,
      buffer: AudioBuffer,
      encodedWAV?: ArrayBuffer,
  ): void

  Update a sound.

  Parameters

  • soundIndex: number

    The index of the sound in the current sprite

  • buffer: AudioBuffer

    The new audio data

  • OptionalencodedWAV: ArrayBuffer

    The data of an encoded WAV. If not provided, the new sound won't be saved if the project is exported.

  Returns void

updateSvg

• updateSvg(
      costumeIndex: number,
      svg: string,
      rotationCenterX: number,
      rotationCenterY: number,
  ): void

  Parameters

  • costumeIndex: number
  • svg: string
  • rotationCenterX: number
  • rotationCenterY: number

  Returns void

variableListener

• variableListener(e: unknown): void

  Handle a Blockly event for the variable map.

  Parameters

  • e: unknown

  Returns void