ResumeUpdateEventOfEngineCamera

Definition

ResumeUpdateEventOfEngineCamera(string engineCameraName)

Description

This function resumes the script’s Update() event of engine camera engineCameraName.

Parameters

engineCameraName

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

Example 1

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

function OnTriggerStay(otherActorName)

end

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

Example 2

--Name of script is ResumeUpdateEventOfEngineCamera2.lua

function Init()
    PauseUpdateEventOfEngineCamera("this")

    ResumeUpdateEventOfEngineCamera("this")
end

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

Assume that the above script named ResumeUpdateEventOfEngineCamera2.lua is attached to an engine camera object named “camera1”. In this case, string “this” in the ResumeUpdateEventOfEngineCamera function will be equal to “camera1”. In our example, we use PauseUpdateEventOfEngineCamera to pause the script’s Update() event of current engine camera, which is “camera1”. Then we use ResumeUpdateEventOfEngineCamera to resume the script’s Update() event of current engine camera, which is “camera1”.