Interface BaseTarget

interface BaseTarget {
    _customState: Partial<CustomState>;
    blocks: Blocks;
    comments: Record<string, Comment>;
    id: string;
    runtime: Runtime;
    soundEffects?: { pan: number; pitch: number };
    variables: Record<string, Variable>;
    createComment(
        id: string,
        blockId: string,
        text: string,
        x: number,
        y: number,
        width: number,
        height: number,
        minimized?: boolean,
    ): void;
    createVariable(
        id: string,
        name: string,
        type: VM.VariableType,
        isCloud?: boolean,
    ): void;
    dispose(): void;
    emit<K extends keyof RenderedTargetEventMap>(
        event: K,
        ...args: EventEmitterArgs<RenderedTargetEventMap, K>,
    ): void;
    getCustomState<T extends keyof CustomState>(
        name: T,
    ): undefined | CustomState[T];
    getName(): string;
    listeners<K extends keyof RenderedTargetEventMap>(
        event: K,
    ): EventEmitterCallback<RenderedTargetEventMap, K>[];
    lookupBroadcastByInputValue(name: string): undefined | BroadcastVariable;
    lookupBroadcastMsg(id: string, name: string): undefined | BroadcastVariable;
    lookupOrCreateList(id: string, name: string): ListVariable;
    lookupOrCreateVariable(id: string, name: string): ScalarVariable;
    lookupVariableById(id: string): undefined | Variable;
    lookupVariableByNameAndType(name: string): undefined | ScalarVariable;
    lookupVariableByNameAndType(
        name: string,
        type: "",
        skipStage?: boolean,
    ): undefined | ScalarVariable;
    lookupVariableByNameAndType(
        name: string,
        type: "list",
        skipStage?: boolean,
    ): undefined | ListVariable;
    lookupVariableByNameAndType(
        name: string,
        type: "broadcast_msg",
        skipStage?: boolean,
    ): undefined | BroadcastVariable;
    off<K extends keyof RenderedTargetEventMap>(
        event: K,
        callback: EventEmitterCallback<RenderedTargetEventMap, K>,
    ): void;
    on<K extends keyof RenderedTargetEventMap>(
        event: K,
        callback: EventEmitterCallback<RenderedTargetEventMap, K>,
    ): void;
    once<K extends keyof RenderedTargetEventMap>(
        event: K,
        callback: EventEmitterCallback<RenderedTargetEventMap, K>,
    ): void;
    onGreenFlag(): void;
    postSpriteInfo(spriteInfo: PostedSpriteInfo): void;
    removeListener<K extends keyof RenderedTargetEventMap>(
        event: K,
        callback: EventEmitterCallback<RenderedTargetEventMap, K>,
    ): void;
    setCustomState<T extends keyof CustomState>(
        name: T,
        value: CustomState[T],
    ): void;
}

Hierarchy (View Summary)

Properties

_customState blocks comments id runtime soundEffects? variables

Methods

createComment createVariable dispose emit getCustomState getName listeners lookupBroadcastByInputValue lookupBroadcastMsg lookupOrCreateList lookupOrCreateVariable lookupVariableById lookupVariableByNameAndType off on once onGreenFlag postSpriteInfo removeListener setCustomState

Properties

_customState

_customState: Partial<CustomState>

blocks

blocks: Blocks

comments

comments: Record<string, Comment>

id

id: string

runtime

runtime: Runtime

OptionalsoundEffects

soundEffects?: { pan: number; pitch: number }

Mirrors custom state.

variables

variables: Record<string, Variable>

Methods

createComment

  • createComment(
        id: string,
        blockId: string,
        text: string,
        x: number,
        y: number,
        width: number,
        height: number,
        minimized?: boolean,
    ): void

  • Parameters

    • id: string
    • blockId: string
    • text: string
    • x: number
    • y: number
    • width: number
    • height: number
    • Optionalminimized: boolean

    Returns void

createVariable

  • createVariable(
        id: string,
        name: string,
        type: VM.VariableType,
        isCloud?: boolean,
    ): void

  • Create a new variable. If the ID is already used, silently does nothing. isCloud is ignored if the sprite is not the stage or if the cloud variable limit has been reached.

    Parameters

    Returns void

dispose

emit

getCustomState

getName

listeners

lookupBroadcastByInputValue

lookupBroadcastMsg

lookupOrCreateList

lookupOrCreateVariable

lookupVariableById

  • lookupVariableById(id: string): undefined | Variable

  • Look for a variable by its ID in this target. If it doesn't exist in this target, will check if it exists in the stage target. If it still doesn't exist, returns undefined.

    Parameters

    • id: string

    Returns undefined | Variable

lookupVariableByNameAndType

off

on

once

onGreenFlag

  • onGreenFlag(): void

  • Called by runtime when the green flag is pressed.

    Returns void

postSpriteInfo

removeListener

setCustomState

Settings

Member Visibility

On This Page

Properties
Methods