Set Foreground: Difference between revisions

(2 intermediate revisions by one other user not shown)

Line 1:

{{Event

| event = Set Foreground

| image = File:~~SetForeground~~.~~jpg~~

| image = File:EditorSetForeground.png

| tablocation = VFX

| eventtype = SetForeground

| versionorigin = ~~r<code>version</code>~~

| versionorigin = r14

| shortcut = Shift+B

}}

'''Set Foreground''' is an event in the '''VFX Tab''' that ~~can overlay~~ an image ~~onto the window~~.

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

== Usage ==

{| class="wikitable"

Line 13:

! Setting !! Type !! Description

|-

| Image || Text Box || ~~Choose an image~~ file to use for the background.

| Image || Text Box || Image file(s) to use for the background.

|-

| Color || Color Picker || ~~Chooses a tint~~ to apply to the image.

| Color || Color Picker || Tint to apply to the image (uses '''Multiply''' blending).

|-

| Scaling || Dropdown || ~~Choose how to scale~~ the image to the ~~window~~.

| 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 ==

<code>{ "bar": 2, "beat": 2, "y": 0, "type": "SetForeground", "rooms": [0], "image": [], "color": "FFFFFFFF", "contentMode": "ScaleToFill" },</code>

<code>{ "bar": X, "beat": X, "y": X, "type": "SetForeground", "rooms": [0], "image": [], "color": "FFFFFFFF", "contentMode": "ScaleToFill" },</code>

<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[])

Line 28:

Line 31:

Tint color. Must be a valid HEXALPHA color.

'''image''' (string)

'''image''' (string[])

~~What image~~ to use for the background.

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 ~~should~~ the image ~~be scaled~~ to the ~~window~~.

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.

@@ Line 1: / Line 1: @@
 {{Event
   | event = Set Foreground
-  | image = File:SetForeground.jpg
+  | image = File:EditorSetForeground.png
   | tablocation = VFX
   | eventtype = SetForeground
-  | versionorigin = r<code>version</code>
+  | versionorigin = r14
   | shortcut = Shift+B
 }}
-'''Set Foreground''' is an event in the '''VFX Tab''' that can overlay an image onto the window.
+'''Set Foreground''' is an event in the '''VFX Tab''' that overlays an image or a sequence of images on top of a '''room'''.
 == Usage ==
 {| class="wikitable"
@@ Line 13: / Line 13: @@
 ! Setting !! Type !! Description
 |-
-| Image || Text Box || Choose an image file to use for the background.
+| Image || Text Box || Image file(s) to use for the background.
 |-
-| Color || Color Picker || Chooses a tint to apply to the image.
+| Color || Color Picker || Tint to apply to the image (uses '''Multiply''' blending).
 |-
-| Scaling || Dropdown || Choose how to scale the image to the window.
+| 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 ==
-<code>{ "bar": 2, "beat": 2, "y": 0, "type": "SetForeground", "rooms": [0], "image": [], "color": "FFFFFFFF", "contentMode": "ScaleToFill" },</code>
+<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[])
@@ Line 28: / Line 31: @@
 <br>Tint color. Must be a valid HEXALPHA color.
-'''image''' (string)
+'''image''' (string[])
-<br>What image to use for the background.
+<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)
-<br> How should the image be scaled to the window.
+<br>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.
 {{EventNavBox}}