ResumeUpdateEventOfLight

Definition

ResumeUpdateEventOfLight(string lightName)

Description

This function resumes the script’s Update() event of light lightName.

Parameters

lightName

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

Example 1

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

function OnTriggerStay(otherActorName)

end

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

Example 2

--Name of script is ResumeUpdateEventOfLight2.lua

function Init()
    PauseUpdateEventOfLight("this")

    ResumeUpdateEventOfLight("this")
end

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

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