Skip to main content

DrawRoomBackground

Callable

  • DrawRoomBackground(URL: string, bounds: Rect, opts?: { blur: number; darken: number; inverted: boolean; sizeMode: number; tints: RGBAColor[] }): void

  • Draws a background image onto the MainCanvas, applying zoom and visual effects


    Parameters

    • URL: string

      The background image to use

    • bounds: Rect

      The location to draw the background in

    • optionalopts: { blur: number; darken: number; inverted: boolean; sizeMode: number; tints: RGBAColor[] }

      The background drawing options

      • blur: number

        How blurry the background is

      • darken: number

        How darkened the background is (1 is bright, 0 is pitch black)

      • inverted: boolean

        Whether the background should be flipped upside-down

      • sizeMode: number

        The method of resizing the background

      • tints: RGBAColor[]

        Tints to apply to the background

    Returns void