Play Song: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 7:

| shortcut = P

}}

'''Play Song''' is an event in the '''Sounds tab''' that plays a song. It can only be placed at the beginning of bars.

Line 37:

Line 36:

|-

| Offset || Text Box (Number) || Offset of the song in ms.

|}

Using multiple '''Play Song''' events can make playback in the middle of the chart break the music sometimes.

=== Advanced ===

'''Songs''' can be modified with some '''custom methods''':

{| class="wikitable"

! Custom Method !! Description

|-

| <code>CurrentSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''.

|-

| <code>PreviousSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the second most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''.

|-

| <code>SongVol(string'''filename.ogg*external''', float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of a specific filename to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''. Can target sound effects from [[Play Sound]].

|-

| <code>StopSong(int'''FadeTimeInSeconds''')</code> || Like '''CurrentSongVol''', with no volume control.

|-

| <code>OneSongAtATime(bool'''Enabled''')</code> || Stops the previous song as soon as a new '''Play Song''' event is triggered.

|}

Line 68:

Line 87:

== Trivia ==

This event is one of ~~two~~ events ~~in the game to~~ not have a "beat~~" argument~~, the ~~other~~ being [[Set Crotchets Per Bar]].

* This event is one of few events that do not have a beat parameter, the others being [[Set Crotchets Per Bar]] and [[Set Heart Explode Volume]].

This is the only event in the game that, regardless of zoom, spans two beats visually in the editor's timeline.

* This is the only event in the game that, regardless of zoom, spans two beats visually in the editor's timeline.

Placing multiple '''Play Song''' events causes the waveform to be a thick line on top of the first song's waveform. This does not affect playback.

* Placing multiple '''Play Song''' events (sometimes) causes the waveform to be a thick line on top of the first song's waveform. This does not affect playback.

@@ Line 7: / Line 7: @@
   | shortcut = P
 }}
 '''Play Song''' is an event in the '''Sounds tab''' that plays a song. It can only be placed at the beginning of bars.
@@ Line 37: / Line 36: @@
 |-
 | Offset || Text Box (Number) || Offset of the song in ms.
+|}
+Using multiple '''Play Song''' events can make playback in the middle of the chart break the music sometimes.
+=== Advanced ===
+'''Songs''' can be modified with some '''custom methods''':
+{| class="wikitable"
+! Custom Method !! Description
+|-
+| <code>CurrentSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''.
+|-
+| <code>PreviousSongVol(float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of the second most recently played song to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''.
+|-
+| <code>SongVol(string'''filename.ogg*external''', float'''TargetVolume''', float'''FadeTimeSeconds''')</code> || Sets the volume of a specific filename to '''TargetVolume''' over the time given in '''FadeTimeSeconds'''. Can target sound effects from [[Play Sound]].
+|-
+| <code>StopSong(int'''FadeTimeInSeconds''')</code> || Like '''CurrentSongVol''', with no volume control.
+|-
+| <code>OneSongAtATime(bool'''Enabled''')</code> || Stops the previous song as soon as a new '''Play Song''' event is triggered.
 |}
@@ Line 68: / Line 87: @@
 == Trivia ==
-This event is one of two events in the game to not have a "beat" argument, the other being [[Set Crotchets Per Bar]].
+* This event is one of few events that do not have a beat parameter, the others being [[Set Crotchets Per Bar]] and [[Set Heart Explode Volume]].
-This is the only event in the game that, regardless of zoom, spans two beats visually in the editor's timeline.
+* This is the only event in the game that, regardless of zoom, spans two beats visually in the editor's timeline.
-Placing multiple '''Play Song''' events causes the waveform to be a thick line on top of the first song's waveform. This does not affect playback.
+* Placing multiple '''Play Song''' events (sometimes) causes the waveform to be a thick line on top of the first song's waveform. This does not affect playback.
 {{EventNavBox}}