ResumeUpdateEventOf3DSound

Definition

ResumeUpdateEventOf3DSound(string 3DSoundName)

Description

This function resumes the script’s Update() event of 3D sound 3DSoundName.

Parameters

3DSoundName

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

Example 1

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

function OnTriggerStay(otherActorName)

end

function OnTriggerExit(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          ResumeUpdateEventOf3DSound("river1")
    end
end

Assume that the above script is attached to a trigger named trigger1. When the main character enters “trigger1”, script’s Update() event of 3D sound “river1” will be paused. When the main character exits “trigger1”, script’s Update() event of 3D sound “river1” will be resumed.

Example 2

--Name of script is ResumeUpdateEventOf3DSound2.lua

function Init()
    PauseUpdateEventOf3DSound("this")

    ResumeUpdateEventOf3DSound("this")
end

function Update()
    PrintConsole("\nUpdate")
end

Assume that the above script named ResumeUpdateEventOf3DSound2.lua is attached to a 3D sound object named “sound1”. In this case, string “this” in the ResumeUpdateEventOf3DSound function will be equal to “sound1”. In our example, we use PauseUpdateEventOf3DSound to pause the script’s Update() event of current 3D sound, which is “sound1”. Then we use ResumeUpdateEventOf3DSound to resume the script’s Update() event of current 3D sound, which is “sound1”.