The "vngen_audio_play_music" Function

Syntax#

vngen_audio_play_music(id, sound, volume, fade, [ease], [start, end, full]);

Argument	Type	Description
`id`	real/string	The unique identifier to use for the new sound
`sound`	sound	The sound resource to play
`volume`	real (0-1)	The sound volume, where 1 is default and 0 is silent
`fade`	real	The length of time to fade sound in, in seconds
`[ease]`	integer/macro	Optional: Sets the ease mode to perform the fade in
`[start]`	real	Optional: Sets the starting point to clip the sound, in seconds
`[end]`	real	Optional: Sets the ending point to clip the sound, in seconds
`[full]`	boolean	Optional: Enables or disables playing from beginning before clipping

note

Clip arguments are a group. All three must be input together, or not at all.

Description#

Plays a new music track with an optional fade in, volume control, and real-time loop clipping. Music is always looped and will not be paused if vngen_toggle_pause is run. Looped audio actions will be marked complete immediately and will not delay the next event until any fade transition is complete.

See Macros & Keywords for a list of available ease modes.

Example#

vngen_event() {
   vngen_audio_play_music("music", mus_battle, 1, 0.5, ease_sin_out);
   vngen_audio_play_music("music", mus_battle, 1, 0.5, 5, 20, true);
}