Set Foreground: Difference between revisions
(Created page) |
(added fps box, added fps surgery example, other) |
||
| Line 1: | Line 1: | ||
{{Event | {{Event | ||
| event = Set Foreground | | event = Set Foreground | ||
| image = File: | | image = File:EditorSetForeground.png | ||
| tablocation = VFX | | tablocation = VFX | ||
| eventtype = SetForeground | | eventtype = SetForeground | ||
| Line 7: | Line 7: | ||
| shortcut = Shift+B | | shortcut = Shift+B | ||
}} | }} | ||
'''Set Foreground''' is an event in the '''VFX Tab''' that | '''Set Foreground''' is an event in the '''VFX Tab''' that overlays an image or a sequence of images on top of a '''room'''. | ||
== Usage == | == Usage == | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 13: | Line 13: | ||
! Setting !! Type !! Description | ! Setting !! Type !! Description | ||
|- | |- | ||
| Image || Text Box || | | Image || Text Box || Image file(s) to use for the background. | ||
|- | |- | ||
| Color || Color Picker || | | Color || Color Picker || Tint to apply to the image (uses '''Multiply''' blending). | ||
|- | |- | ||
| Scaling || Dropdown || | | 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 == | == Surgery == | ||
<code>{ "bar": | <code>{ "bar": X, "beat": X, "y": X, "type": "SetForeground", "rooms": [0], "image": [], "color": "FFFFFFFF", "contentMode": "ScaleToFill" },</code> | ||
<br><code>{ "bar": X, "beat": X, "y": X, "type": "SetForeground", "rooms": [0], "image": ["foo.png", "bar.png"], "color": "FFFFFFFF", "fps": 30, "contentMode": "ScaleToFill" },</code> | |||
'''rooms''' (integer[]) | '''rooms''' (integer[]) | ||
| Line 28: | Line 31: | ||
<br>Tint color. Must be a valid HEXALPHA color. | <br>Tint color. Must be a valid HEXALPHA color. | ||
'''image''' (string) | '''image''' (string[]) | ||
<br> | <br>Image(s) to use for the background. | ||
'''fps''' (number) | |||
<br>FPS to use for the sequence of images. Optional if '''image''' has 1 image. | |||
'''contentMode''' (enum) | '''contentMode''' (enum) | ||
<br> How | <br>How the image should scale to the game aspect ratio. ''Center'', ''ScaleToFill'', ''AspectFit'', ''AspectFill'', ''Tiled'', or ''Real''. | ||
{{EventNavBox}} | {{EventNavBox}} | ||
Revision as of 23:56, 3 August 2026
| 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.