Interface BlockUtility

interface BlockUtility {
    _nowObj: { now(): number };
    nowObj: { now(): number };
    runtime: Runtime;
    sequencer: Sequencer;
    stackFrame: StackFrame;
    startHats: (
        opcode: string,
        matchFields?: Record<string, unknown>,
        target?: RenderedTarget,
    ) => Thread[];
    target: RenderedTarget;
    thread: Thread;
    getParam(name: string): ScratchCompatibleValue;
    getProcedureParamNamesAndIds(): [string[], string[]];
    getProcedureParamNamesIdsAndDefaults(): [string[], string[], string[]];
    initParams(): void;
    ioQuery<Device extends keyof IODevices>(
        device: Device,
        func: keyof IODevices[Device],
        args: unknown[],
    ): unknown;
    pushParam(name: string, value: ScratchCompatibleValue): void;
    stackTimerFinished(): boolean;
    stackTimerNeedsInit(): boolean;
    startBranch(branchNumber: number, isLoop: boolean): void;
    startStackTimer(milliseconds: number): void;
    stopAll(): void;
    stopOtherTargetThreads(): void;
    stopThisScript(): void;
    yield(): void;
    yieldTick(): void;
}

Properties

_nowObj nowObj runtime sequencer stackFrame startHats target thread

Methods

getParam getProcedureParamNamesAndIds getProcedureParamNamesIdsAndDefaults initParams ioQuery pushParam stackTimerFinished stackTimerNeedsInit startBranch startStackTimer stopAll stopOtherTargetThreads stopThisScript yield yieldTick

Properties

_nowObj

_nowObj: { now(): number }

nowObj

nowObj: { now(): number }

runtime

runtime: Runtime

sequencer

sequencer: Sequencer

stackFrame

stackFrame: StackFrame

startHats

startHats: (
    opcode: string,
    matchFields?: Record<string, unknown>,
    target?: RenderedTarget,
) => Thread[]

Use instead of runtime.startHats inside blocks.

See

target

target: RenderedTarget

thread

thread: Thread

Methods

getParam

getProcedureParamNamesAndIds

  • getProcedureParamNamesAndIds(): [string[], string[]]

  • Returns [string[], string[]]

    See

getProcedureParamNamesIdsAndDefaults

  • getProcedureParamNamesIdsAndDefaults(): [string[], string[], string[]]

  • Returns [string[], string[], string[]]

    See

initParams

ioQuery

pushParam

stackTimerFinished

stackTimerNeedsInit

startBranch

  • startBranch(branchNumber: number, isLoop: boolean): void

  • Parameters

    • branchNumber: number
    • isLoop: boolean

    Returns void

startStackTimer

  • startStackTimer(milliseconds: number): void

  • Parameters

    • milliseconds: number

    Returns void

stopAll

stopOtherTargetThreads

stopThisScript

yield

yieldTick

Settings

Member Visibility

On This Page

Properties
Methods