Class VM

Hierarchy (View Summary)

EventEmitter<VirtualMachineEventMap>
- VM

Index

Constructors

Properties

_dragTarget assets editingTarget exports extensionManager renderer runtime securityManager

Methods

addAddonBlock addBackdrop addCostume addCostumeFromLibrary addSound addSprite attachAudioEngine attachRenderer attachStorage attachV2BitmapAdapter attachV2SVGAdapter clear connectPeripheral convertToPackagedRuntime deleteCostume deleteSound deleteSprite deserializeProject disconnectPeripheral downloadProjectId duplicateCostume duplicateSound duplicateSprite emit emitTargetsUpdate emitWorkspaceUpdate enableDebug exportSprite fromJSON getAddonBlock getCostume getExportedCostume getExportedCostumeBase64 getPeripheralIsConnected getSoundBuffer getTargetIdForDrawableId getVariableValue greenFlag installTargets listeners loadProject off on once postIOData postSpriteInfo quit refreshWorkspace removeListener renameCostume renameSound renameSprite reorderCostume reorderSound reorderTarget saveProjectSb3 saveProjectSb3DontZip saveProjectSb3Stream scanForPeripheral setCloudProvider setCompatibilityMode setCompilerOptions setEditingTarget setFramerate setInEditor setInterpolation setRuntimeOptions setStageSize setTurboMode setVariableValue setVideoProvider shareBlocksToTarget shareCostumeToTarget shareSoundToTarget start startDrag stop stopAll stopDrag storeProjectOptions toJSON updateBitmap updateSoundBuffer updateSvg

Constructors

constructor

new VM(): VM
Returns VM
Overrides EventEmitter.constructor
- Defined in types/scratch-vm.d.ts:1593

Properties

_dragTarget

_dragTarget: RenderedTarget | null

The target that's currently being dragged, if any.

assets

assets: Asset[]

editingTarget

editingTarget: RenderedTarget | null

See

exports

exports: {
    RenderedTarget: new (
        sprite: VM.Sprite,
        runtime: Runtime,
    ) => RenderedTarget;
    Sprite: new (blocks: Blocks | null, runtime: Runtime) => VM.Sprite;
}

extensionManager

extensionManager: ExtensionManager

renderer

renderer: RenderWebGL

runtime

runtime: Runtime

securityManager

securityManager: SecurityManager

Methods

addAddonBlock

addAddonBlock(addonBlock: AddonBlockOptions): void
Parameters
- addonBlock: AddonBlockOptions
Returns void
- Defined in types/scratch-vm.d.ts:1577

addBackdrop

addBackdrop(md5ext: string, costume?: Costume): Promise<void>
Parameters
- md5ext: string
- Optionalcostume: Costume
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1744

addCostume

addCostume(
    md5ext: string,
    costume?: Costume,
    targetId?: string,
    version?: 2,
): Promise<void>
Parameters
- md5ext: string
- Optionalcostume: Costume
- OptionaltargetId: string
- Optionalversion: 2
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1740

addCostumeFromLibrary

addCostumeFromLibrary(md5ext: string, costume: Costume): Promise<void>
Parameters
- md5ext: string
- costume: Costume
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1742

addSound

addSound(sound: VM.Sound, targetId?: string): Promise<void>
Parameters
- sound: VM.Sound
- OptionaltargetId: string
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1746

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>
- Defined in types/scratch-vm.d.ts:1738

attachAudioEngine

attachAudioEngine(audioEngine: AudioEngine): void
Parameters
- audioEngine: AudioEngine
Returns void
See
- Defined in types/scratch-vm.d.ts:1607

attachRenderer

attachRenderer(renderer: RenderWebGL): void
Parameters
- renderer: RenderWebGL
Returns void
See
- Defined in types/scratch-vm.d.ts:1602

attachStorage

attachStorage(storage: ScratchStorage): void
Parameters
- storage: ScratchStorage
Returns void
See
- Defined in types/scratch-vm.d.ts:1622

attachV2BitmapAdapter

attachV2BitmapAdapter(bitmapAdapter: BitmapAdapter): void
Parameters
- bitmapAdapter: BitmapAdapter
Returns void
See
- Defined in types/scratch-vm.d.ts:1617

attachV2SVGAdapter

attachV2SVGAdapter(): void
Returns void
Deprecated
Does nothing.
- Defined in types/scratch-vm.d.ts:1612

clear

clear(): void
Remove everything from the VM.

Returns void
- Defined in types/scratch-vm.d.ts:1663

connectPeripheral

connectPeripheral(extensionID: string, peripheralId: number): void
Parameters
- extensionID: string
- peripheralId: number
Returns void
See
- Defined in types/scratch-vm.d.ts:1858

convertToPackagedRuntime

convertToPackagedRuntime(): void
Returns void
- Defined in types/scratch-vm.d.ts:1576

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.
- Defined in types/scratch-vm.d.ts:1788

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.
- Defined in types/scratch-vm.d.ts:1794

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.
- Defined in types/scratch-vm.d.ts:1782

deserializeProject

deserializeProject(json: object, zip?: JSZip): Promise<void>
Parameters
- json: object
- Optionalzip: JSZip
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1676

disconnectPeripheral

disconnectPeripheral(extensionID: string): void
Parameters
- extensionID: string
Returns void
See
- Defined in types/scratch-vm.d.ts:1863

downloadProjectId

downloadProjectId(id: string | number): Promise<void>
Load a project usings its ID from scratch.mit.edu.
Parameters
- id: string | number
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1674

duplicateCostume

duplicateCostume(costumeIndex: number): Promise<void>
Parameters
- costumeIndex: number
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1750

duplicateSound

duplicateSound(soundIndex: number): Promise<void>
Parameters
- soundIndex: number
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1752

duplicateSprite

duplicateSprite(targetId: string): Promise<void>
Parameters
- targetId: string
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1748

emit

emit<K extends keyof VirtualMachineEventMap>(
event: K,
...args: EventEmitterArgs<VirtualMachineEventMap, K>,
): void
Type Parameters
- K extends keyof VirtualMachineEventMap
Parameters
- event: K
- ...args: EventEmitterArgs<VirtualMachineEventMap, K>
Returns void
Inherited from EventEmitter.emit
- Defined in types/events.d.ts:13

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
- Defined in types/scratch-vm.d.ts:1817

emitWorkspaceUpdate

emitWorkspaceUpdate(): void
Emit a workspaceUpdate event.

Returns void
- Defined in types/scratch-vm.d.ts:1822

enableDebug

enableDebug(): string
Returns string
- Defined in types/scratch-vm.d.ts:1580

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>
- Defined in types/scratch-vm.d.ts:1722
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>
- Defined in types/scratch-vm.d.ts:1723

fromJSON

fromJSON(
input: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>,
): Promise<void>
Parameters
- input: string | object | ArrayBuffer | ArrayBufferView<ArrayBuffer>
Returns Promise<void>
Deprecated
See
- Defined in types/scratch-vm.d.ts:1684

getAddonBlock

getAddonBlock(procedureCode: string): AddonBlock
Parameters
- procedureCode: string
Returns AddonBlock
- Defined in types/scratch-vm.d.ts:1578

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
- Defined in types/scratch-vm.d.ts:1731

getExportedCostume

getExportedCostume(costume: Costume): Uint8Array
Parameters
- costume: Costume
Returns Uint8Array
- Defined in types/scratch-vm.d.ts:1581

getExportedCostumeBase64

getExportedCostumeBase64(costume: Costume): string
Parameters
- costume: Costume
Returns string
- Defined in types/scratch-vm.d.ts:1582

getPeripheralIsConnected

getPeripheralIsConnected(extensionID: string): boolean
Parameters
- extensionID: string
Returns boolean
See
- Defined in types/scratch-vm.d.ts:1868

getSoundBuffer

getSoundBuffer(soundIndex: number): AudioBuffer | null
Parameters
- soundIndex: number
Returns AudioBuffer | null
- Defined in types/scratch-vm.d.ts:1733

getTargetIdForDrawableId

getTargetIdForDrawableId(drawableId: number): string | null
Parameters
- drawableId: number
Returns string | null
- Defined in types/scratch-vm.d.ts:1706

getVariableValue

getVariableValue(targetId: string, variableId: string): VariableValue | null
Parameters
- targetId: string
- variableId: string
Returns VariableValue | null
- Defined in types/scratch-vm.d.ts:1714

greenFlag

greenFlag(): void
Returns void
See
- Defined in types/scratch-vm.d.ts:1639

installTargets

installTargets(
    targets: RenderedTarget[],
    extensions: ImportedExtensionsInfo,
    wholeProject: boolean,
): Promise<void>
Parameters
- targets: RenderedTarget[]
- extensions: ImportedExtensionsInfo
- wholeProject: boolean
Returns Promise<void>
- Defined in types/scratch-vm.d.ts:1678

listeners

listeners<K extends keyof VirtualMachineEventMap>(
event: K,
): EventEmitterCallback<VirtualMachineEventMap, K>[]
Type Parameters
- K extends keyof VirtualMachineEventMap
Parameters
- event: K
Returns EventEmitterCallback<VirtualMachineEventMap, K>[]
Inherited from EventEmitter.listeners
- Defined in types/events.d.ts:12

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>
- Defined in types/scratch-vm.d.ts:1669

postIOData

postIOData(device: "cloud", data: CloudData): void
Parameters
- device: "cloud"
- data: CloudData
Returns void
- Defined in types/scratch-vm.d.ts:1839
postIOData(device: "keyboard", data: KeyboardData): void
Parameters
- device: "keyboard"
- data: KeyboardData
Returns void
- Defined in types/scratch-vm.d.ts:1840
postIOData(device: "mouse", data: MouseData): void
Parameters
- device: "mouse"
- data: MouseData
Returns void
- Defined in types/scratch-vm.d.ts:1841
postIOData(device: "mouseWheel", data: MouseWheelData): void
Parameters
- device: "mouseWheel"
- data: MouseWheelData
Returns void
- Defined in types/scratch-vm.d.ts:1842
postIOData(device: "userData", data: UserDataData): void
Parameters
- device: "userData"
- data: UserDataData
Returns void
- Defined in types/scratch-vm.d.ts:1843
postIOData(device: "video", data: VideoData): void
Parameters
- device: "video"
- data: VideoData
Returns void
- Defined in types/scratch-vm.d.ts:1844

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
- Defined in types/scratch-vm.d.ts:1828

quit

quit(): void
Returns void
See
- Defined in types/scratch-vm.d.ts:1634

refreshWorkspace

refreshWorkspace(): void
Returns void
- Defined in types/scratch-vm.d.ts:1811

removeListener

removeListener<K extends keyof VirtualMachineEventMap>(
event: K,
callback: EventEmitterCallback<VirtualMachineEventMap, K>,
): void
Type Parameters
- K extends keyof VirtualMachineEventMap
Parameters
- event: K
- callback: EventEmitterCallback<VirtualMachineEventMap, K>
Returns void
Inherited from EventEmitter.removeListener
- Defined in types/events.d.ts:11

renameCostume

renameCostume(costumeIndex: number, newName: string): void
Parameters
- costumeIndex: number
- newName: string
Returns void
- Defined in types/scratch-vm.d.ts:1774

renameSound

renameSound(soundIndex: number, newName: string): void
Parameters
- soundIndex: number
- newName: string
Returns void
- Defined in types/scratch-vm.d.ts:1776

renameSprite

renameSprite(targetId: string, newName: string): void
Parameters
- targetId: string
- newName: string
Returns void
- Defined in types/scratch-vm.d.ts:1772

reorderCostume

reorderCostume(
    targetId: string,
    costumeIndex: number,
    newIndex: number,
): boolean
Parameters
- targetId: string
- costumeIndex: number
- newIndex: number
Returns boolean
- Defined in types/scratch-vm.d.ts:1768

reorderSound

reorderSound(targetId: string, soundIndex: number, newIndex: number): boolean
Parameters
- targetId: string
- soundIndex: number
- newIndex: number
Returns boolean
- Defined in types/scratch-vm.d.ts:1770

reorderTarget

reorderTarget(targetId: string, newIndex: number): boolean
Parameters
- targetId: string
- newIndex: number
Returns boolean
- Defined in types/scratch-vm.d.ts:1766

saveProjectSb3

saveProjectSb3<T extends keyof OutputTypes>(type: T): Promise<OutputTypes[T]>
the project to a compressed sb3 file.
Type Parameters
- T extends keyof OutputTypes
Parameters
- type: T
Returns Promise<OutputTypes[T]>
- Defined in types/scratch-vm.d.ts:1690
saveProjectSb3(): Promise<Blob>
the project to a compressed sb3 file.

Returns Promise<Blob>
- Defined in types/scratch-vm.d.ts:1691

saveProjectSb3DontZip

saveProjectSb3DontZip(): Record<string, Uint8Array>
Returns Record<string, Uint8Array>
- Defined in types/scratch-vm.d.ts:1568

saveProjectSb3Stream

saveProjectSb3Stream(): StreamHelper<"arraybuffer">
Returns StreamHelper<"arraybuffer">
- Defined in types/scratch-vm.d.ts:1566
saveProjectSb3Stream<T extends keyof OutputTypes>(type: T): StreamHelper<T>
Type Parameters
- T extends keyof OutputTypes
Parameters
- type: T
Returns StreamHelper<T>
- Defined in types/scratch-vm.d.ts:1567

scanForPeripheral

scanForPeripheral(extensionID: string): void
Parameters
- extensionID: string
Returns void
See
- Defined in types/scratch-vm.d.ts:1853

setCloudProvider

setCloudProvider(cloudProvider: CloudProvider): void
Parameters
- cloudProvider: CloudProvider
Returns void
- Defined in types/scratch-vm.d.ts:1848

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
- Defined in types/scratch-vm.d.ts:1653

setCompilerOptions

setCompilerOptions(compilerOptions: Partial<CompilerOptions>): void
Parameters
- compilerOptions: Partial<CompilerOptions>
Returns void
- Defined in types/scratch-vm.d.ts:1572

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
- Defined in types/scratch-vm.d.ts:1704

setFramerate

setFramerate(framerate: number): void
Parameters
- framerate: number
Returns void
- Defined in types/scratch-vm.d.ts:1570

setInEditor

setInEditor(inEditor: boolean): void
Parameters
- inEditor: boolean
Returns void
- Defined in types/scratch-vm.d.ts:1575

setInterpolation

setInterpolation(interpolation: boolean): void
Parameters
- interpolation: boolean
Returns void
- Defined in types/scratch-vm.d.ts:1571

setRuntimeOptions

setRuntimeOptions(runtimeOptions: Partial<RuntimeOptions>): void
Parameters
- runtimeOptions: Partial<RuntimeOptions>
Returns void
- Defined in types/scratch-vm.d.ts:1573

setStageSize

setStageSize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in types/scratch-vm.d.ts:1574

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
- Defined in types/scratch-vm.d.ts:1646

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
- Defined in types/scratch-vm.d.ts:1712

setVideoProvider

setVideoProvider(videoProvider: VideoProvider): void
Parameters
- videoProvider: VideoProvider
Returns void
- Defined in types/scratch-vm.d.ts:1846

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>
- Defined in types/scratch-vm.d.ts:1799

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>
- Defined in types/scratch-vm.d.ts:1804

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>
- Defined in types/scratch-vm.d.ts:1809

start

start(): void
Returns void
See
- Defined in types/scratch-vm.d.ts:1629

startDrag

startDrag(targetId: string): void
Parameters
- targetId: string
Returns void
- Defined in types/scratch-vm.d.ts:1835

stop

stop(): void
Returns void
- Defined in types/scratch-vm.d.ts:1569

stopAll

stopAll(): void
Returns void
See
- Defined in types/scratch-vm.d.ts:1658

stopDrag

stopDrag(targetId: string): void
Parameters
- targetId: string
Returns void
- Defined in types/scratch-vm.d.ts:1837

storeProjectOptions

storeProjectOptions(): void
Returns void
- Defined in types/scratch-vm.d.ts:1579

toJSON

toJSON(targetId?: string): string
Parameters
- OptionaltargetId: string
Returns string
- Defined in types/scratch-vm.d.ts:1693

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
- Defined in types/scratch-vm.d.ts:1756

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
- Defined in types/scratch-vm.d.ts:1764

updateSvg

updateSvg(
    costumeIndex: number,
    svg: string,
    rotationCenterX: number,
    rotationCenterY: number,
): void
Parameters
- costumeIndex: number
- svg: string
- rotationCenterX: number
- rotationCenterY: number
Returns void
- Defined in types/scratch-vm.d.ts:1754

Class VM

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns VM

Properties

_dragTarget

assets

editingTarget

See

exports

extensionManager

renderer

runtime

securityManager

Methods

addAddonBlock

Parameters

Returns void

addBackdrop

Parameters

Returns Promise<void>

addCostume

Parameters

Returns Promise<void>

addCostumeFromLibrary

Parameters

Returns Promise<void>

addSound

Parameters

Returns Promise<void>

addSprite

Parameters

Returns Promise<void>

attachAudioEngine

Parameters

Returns void

See

attachRenderer

Parameters

Returns void

See

attachStorage

Parameters

Returns void

See

attachV2BitmapAdapter

Parameters

Returns void

See

attachV2SVGAdapter

Returns void

Deprecated

clear

Returns void

connectPeripheral

Parameters

Returns void

See

convertToPackagedRuntime

Returns void

deleteCostume

Parameters

Returns (() => void) | null

deleteSound

Parameters

Returns (() => void) | null

deleteSprite

Parameters

Returns (() => void) | null

deserializeProject

Parameters

Returns Promise<void>

disconnectPeripheral

Parameters

Returns void