PauseUpdateEventOfAllAmbientSounds

Definition

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

Description

This function pauses the script’s Update() event of all ambient sounds except the script’s Update() event of ambient sounds passed to the function.

Parameters

[optional] string exception_1, [optional] string exception_2,, [optional] string exception_n
Specifies the name of the ambient sounds whose script’s Update() event should not be paused by this function. If no name is passed to the function, Update() events of all ambient sound scripts will be paused.

Example

function OnTriggerEnter(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          PauseUpdateEventOfAllAmbientSounds("ambient2""ambient3")
    end
end

function OnTriggerStay(otherActorName)

end

function OnTriggerExit(otherActorName)

end
Assume that the above script is attached to a trigger named trigger1. Also assume that “ambient2” and “ambient3” in the example above are the name of ambient sound objects.
Whenever the main character enters “trigger1”, script’s Update() event of all ambient sounds except  script’s Update() event of “ambient2” and “ambient3” ambient sounds will be paused.
adminPauseUpdateEventOfAllAmbientSounds