Set Background

Revision as of 19:20, 29 July 2026 by Protolyte (talk | contribs) (Created the page for Set Background w/ surgery and usage info)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Set Background
TabVFX
TypeSetBackgroundColor
Originr1
ShortcutB

Set Background is an event in the VFX Tab that can change the level's background using a color or an image.

Usage

Color

Setting Type Description
Color Color Picker Chooses a solid color to set the background to.

Image

Setting Type Description
Image Text Box (text) Choose an image file to use for the background.
Color Color Picker Chooses a tint to apply to the image.
Scaling Dropdown Choose how to scale the image to the window.

Surgery

Color

{ "bar": X, "beat": X, "y": X, "type": "SetBackgroundColor", "rooms": [0], "backgroundType": "Color", "color": "FFFFFFFF", "filter": "NearestNeighbor" }

Image

{ "bar": 1, "beat": 1, "y": 0, "type": "SetBackgroundColor", "rooms": [0], "backgroundType": "Image", "image": [], "color": "FFFFFFFF", "contentMode": "ScaleToFill", "filter": "NearestNeighbor" }

rooms (integer[])
Rooms to apply to.

backgroundType (enum)
Whether to use an image or a color background.

color (string)
Tint color. Must be a valid HEXALPHA color.

image (string)
What image to use for the background.

contentMode (enum)
How should the image be scaled to the window.