Skip to main content

The "vngen_audio_replace" Function

Syntax#

vngen_audio_replace(id, sound, [fade], [ease]);
ArgumentTypeDescription
idreal/stringThe ID of the audio entity to replace
soundsoundThe new sound to play
[fade]realOptional: Sets the duration of the fade transition, in seconds
[ease]integer/macroOptional: Sets the ease mode to perform the transition in

Description#

Replaces the input entity ID with a new sound and fades the old sound to the new one over the input duration. Playback position and other properties will be synchronized between sounds, making this function ideal for transitioning between music tracks.

As with other types of modifications, replacements made with this script are permanent and will persist until another replacement is performed. This script cannot be performed simultaneously with other replacement actions operating on the same entity ID.

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

Example#

if (vngen_event()) {
vngen_audio_replace("music", music_intense);
}