Set Foreground

Set Foreground
Tab	VFX
Type	SetForeground
Origin	rversion
Shortcut	Shift+B

Set Foreground is an event in the VFX Tab that overlays an image or a sequence of images on top of a room.

Usage

Setting	Type	Description
Image	Text Box	Image file(s) to use for the background.
Color	Color Picker	Tint to apply to the image (uses Multiply blending).
FPS	Text Box	FPS to use for the sequence of images. Only appears if multiple images are selected (displayed as "[multiple images]").
Scaling	Dropdown	How the image should scale to the game aspect ratio.

Surgery

{ "bar": X, "beat": X, "y": X, "type": "SetForeground", "rooms": [0], "image": [], "color": "FFFFFFFF", "contentMode": "ScaleToFill" },
{ "bar": X, "beat": X, "y": X, "type": "SetForeground", "rooms": [0], "image": ["foo.png", "bar.png"], "color": "FFFFFFFF", "fps": 30, "contentMode": "ScaleToFill" },

rooms (integer[])
Rooms to apply to.

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

image (string[])
Image(s) to use for the background.

fps (number)
FPS to use for the sequence of images. Optional if image has 1 image.

contentMode (enum)
How the image should scale to the game aspect ratio. Center, ScaleToFill, AspectFit, AspectFill, Tiled, or Real.

History

• r38: Shortcut was changed from G to Shift+B.