StopAllResourceSounds | Vanda Engine

Definition

StopAllResourceSounds([optional] string exception_1, [optional] string exception_2,..., [optional] string exception_n)

Description

This function stops all resource sounds that are being played except for the resource sounds sent to the function.

Parameters

[optional] string exception_1, [optional] string exception_2,…, [optional] string exception_n

Specifies the name of the resource sounds that should not stop by this function. If no name is passed to StopAllResourceSounds function, all resource sounds that are being played will stop.

Example

function OnTriggerEnter(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          LoadResource("Sounds", "fire.ogg")
          LoadResource("Sounds", "river.ogg")
          LoadResource("Sounds", "ambient.ogg")

          PlayResourceSoundLoop("Sounds_fire.ogg")
          PlayResourceSoundLoop("Sounds_river.ogg")
          PlayResourceSoundLoop("Sounds_ambient.ogg")
    end
end

function OnTriggerStay(otherActorName)

end

function OnTriggerExit(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          StopAllResourceSounds("Sounds_ambient.ogg")
    end
end

Assume that the above script is attached to a trigger named “trigger1”. Whenever the main character enters “trigger1”, we load and play “fire.ogg”, “river.ogg” and “ambient.ogg” resource sounds –In order for LoadResource function to load the resources, you must first add all resources through the Add Resource to Current Project dialog (File > Project > Add/Remove Resource to/from Current Project).

Whenever the main character exits “trigger1”, all resource sounds that are playing except the resource sound “ambient.ogg” will stop.