Skip to main content

Music & Sound Effects

Events for playing and controlling music and sound effects.

Actions​

Load & Play Music Track​

Load & plays a music file. If you play a new song while another song is playing, the old song will stop automatically.
Load & Play Music Track
Song
   Song 1                                                     vgm
Loop
  • Song: The song to play.
  • Loop: If the music will loop or not.

Load Music Track​

Load a music file. You can play it later with 'Play Music Song'.
Load Music Track
Song
   Song 1                                                     vgm
  • Song: The song to play.

Play Music Track​

Play the loaded a music file. If you play a new song while another song is playing, the old song will stop automatically.
Play Music Track
Song
   Song 1                                                     vgm
Loop
  • Song: The song to play.
  • Loop: If the music will loop or not.

Pause Music​

Pause any currently playing music, only works with VGM files.
Pause Music
Pauses any music that was previously playing.

Resume Music​

Resume any currently playing music, only works with VGM files.
Resume Music
Resumes any music that was previously paused.

Stop Music​

Stops any currently playing music.
Stop Music
Stops any music that was previously playing.

Play Sound Effect​

Play a sound effect, choose a .WAV file from '/assets/sounds'.
Play Sound Effect
Sound Effect
   jump_sound.wav
Channel
Auto Selection
Priority
6
Loop
  • Sound Effect: The sound effect to play. Can choose from files within '/assets/sounds'.
  • Channel: Channel to use to play sample.
  • Priority: The priority of the effect, from 0 to 15 where 0 is lowest priority and 15 the highest one. If two sound effects are playing at the same time then higher priority sound effects will take precedence.
  • Loop: If the sound will loop or not.

Control Flow​

If Music Playing​

Conditionally run part of the script if music is playing.
If Music Playing
True
Add Event

Properties​

Fade Music In​

Fade the music from 0 up to the current volume, only works with VGM files. Must be called right after a play or resume.
Fade Music In
Duration
0.5
  • Duration: The length of time needed to perform the fade in seconds or frames.

Fade Music Out​

Fade the music to 0 from current levels, only works with VGM files.
Fade Music Out
Duration
0.5
Pause
Stop
  • Duration: The length of time to pause the script for in seconds or frames.
  • Pause: If we pause music after fading, only works with VGM files.
  • Stop: If we stop music after fading, only works with VGM files.

Set FM & PSG Volume​

Sets the FM & PSG Volume to the selected values.
Set FM & PSG Volume
FM volume.
100
PSG volume.
100
  • FM volume.: The FM volume.
  • PSG volume.: The PSG volume.