Play Song: Difference between revisions

Jump to navigation Jump to search
(Created page with "{{Event | event = Play Song | image = File:EditorPlaySong.png | tablocation = Sounds | eventtype = PlaySong | versionorigin = r1 | 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. This event isn't restricted to playing songs, but its general purpose is to do so, and playing other things like SFX are better suited for Play Sound. == Usage == {| class="wikitable" |+ Properti...")
 
Line 68: Line 68:
== Trivia ==
== Trivia ==


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


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.

Revision as of 06:58, 14 October 2024

Play Song
Screenshot of the Event Icon Play Song
TabSounds
TypePlaySong
Originr1
ShortcutP


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

This event isn't restricted to playing songs, but its general purpose is to do so, and playing other things like SFX are better suited for Play Sound.

Usage

Properties
Setting Type Description
Song Text Box (String) Filename of the song. Allows internal filenames.
Song settings Popup Settings of the song. Includes volume, pitch, pan, and offset.
Beats per minute Text Box (Number) Beats per minute. Can be overwritten with Set Beats Per Minute at any point.

Song settings

Setting Type Description
Volume Slider with Text Box (Number) Volume of the song. Ranges from 0% to 300%. 0% doesn't play the song.
Pitch Slider with Text Box (Number) Pitch of the song. Ranges from 0% to 300%.
Pan Slider with Text Box (Number) Panning of the song. Ranges from -100% to 100%.
Offset Text Box (Number) Offset of the song in ms.

Surgery

{ "bar": X, "y": X, "type": "PlaySong", "song": {"filename": "sndOrientalTechno", "volume": 0, "pitch": 0, "pan": 0, "offset": 0}, "bpm": 100, "loop": false },

filename (string)
Song filename. Allows internal filenames with no extension.

volume (integer) (optional)
Goes from 0 to 300.

pitch (integer) (optional)
Goes from 0 to 300.

pan (integer) (optional)
Goes from -100 to 100.

offset (integer) (optional)
Offset of the song. Supports negative values.

bpm (float)
Functions the same way as Set Beats Per Minute.

loop (bool)
Deprecated, non-functional. See this event's History.

History

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