PauseUpdateEventOfAmbientSound

Definition

PauseUpdateEventOfAmbientSound(string ambientSoundName)

Description

This function pauses the script’s Update() event of ambient sound ambientSoundName.

Parameters

ambientSoundName
Specifies the name of the ambient sound. You can also use the name “this” for this parameter. In this case, “this” refers to the ambient sound name that this script is attached to.

Example 1

function OnTriggerEnter(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          PauseUpdateEventOfAmbientSound("ambient1")
    end
end

function OnTriggerStay(otherActorName)

end

function OnTriggerExit(otherActorName)

end
Assume that the above script is attached to a trigger named trigger1. Whenever the main character enters “trigger1”, script’s Update() event of ambient sound “ambient1” will be paused.

Example 2

--Name of script is PauseUpdateEventOfAmbientSound2.lua

function Init()
    PauseUpdateEventOfAmbientSound("this")
end

function Update()

end
Assume that the above script named PauseUpdateEventOfAmbientSound2.lua is attached to an ambient sound object named “sound1”. In this case, string “this”  in the PauseUpdateEventOfAmbientSound function will be equal to “sound1”. In our example, the function PauseUpdateEventOfAmbientSound pauses the script’s Update() event of current ambient sound, which is “sound1”.
adminPauseUpdateEventOfAmbientSound