ResumeUpdateEventOfWater

Definition

ResumeUpdateEventOfWater(string waterName)

Description

This function resumes the script’s Update() event of water waterName.

Parameters

waterName

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

Example 1

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

function OnTriggerStay(otherActorName)

end

function OnTriggerExit(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          ResumeUpdateEventOfWater("water1")
    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 water “water1” will be paused. When the main character exits “trigger1”, script’s Update() event of water “water1” will be resumed.

Example 2

--Name of script is ResumeUpdateEventOfWater2.lua

function Init()
    PauseUpdateEventOfWater("this")

    ResumeUpdateEventOfWater("this")
end

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

Assume that the above script named ResumeUpdateEventOfWater2.lua is attached to a water object named “water1”. In this case, string “this” in the ResumeUpdateEventOfWater function will be equal to “water1”. In our example, we use PauseUpdateEventOfWater to pause the script’s Update() event of current water, which is “water1”. Then we use ResumeUpdateEventOfWater to resume the script’s Update() event of current water, which is “water1”.