@turbowarp/types-tw
    Preparing search index...

    Interface BaseTarget

    interface BaseTarget {
        _customState: Partial<CustomState>;
        blocks: Blocks;
        comments: Record<string, Comment>;
        extensionStorage: ExtensionStorage;
        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,
        ): CustomState[T] | undefined;
        getName(): string;
        listeners<K extends keyof RenderedTargetEventMap>(
            event: K,
        ): EventEmitterCallback<RenderedTargetEventMap, K>[];
        lookupBroadcastByInputValue(name: string): BroadcastVariable | undefined;
        lookupBroadcastMsg(id: string, name: string): BroadcastVariable | undefined;
        lookupOrCreateList(id: string, name: string): ListVariable;
        lookupOrCreateVariable(id: string, name: string): ScalarVariable;
        lookupVariableById(id: string): Variable | undefined;
        lookupVariableByNameAndType(name: string): ScalarVariable | undefined;
        lookupVariableByNameAndType(
            name: string,
            type: "",
            skipStage?: boolean,
        ): ScalarVariable | undefined;
        lookupVariableByNameAndType(
            name: string,
            type: "list",
            skipStage?: boolean,
        ): ListVariable | undefined;
        lookupVariableByNameAndType(
            name: string,
            type: "broadcast_msg",
            skipStage?: boolean,
        ): BroadcastVariable | undefined;
        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)

    Index

    Properties

    _customState blocks comments extensionStorage 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
    comments: Record<string, Comment>
    extensionStorage: ExtensionStorage
    id: string
    runtime: Runtime
    soundEffects?: { pan: number; pitch: number }

    Mirrors custom state.

    variables: Record<string, Variable>

    Methods

    • Parameters

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

      Returns 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

    • 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 Variable | undefined

    Settings

    Member Visibility

    On This Page

    Properties
    Methods