PauseUpdateEventOfEngineCamera

Definition

PauseUpdateEventOfEngineCamera(string engineCameraName)

Description

This function pauses 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 name 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)

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

Example 2

--Name of script is PauseUpdateEventOfEngineCamera2.lua

function Init()
    PauseUpdateEventOfEngineCamera("this")
end

function Update()

end
Assume that the above script named PauseUpdateEventOfEngineCamera2.lua is attached to an engine camera object named “camera1”. In this case, string “this”  in the PauseUpdateEventOfEngineCamera function will be equal to “camera1”. In our example, the function PauseUpdateEventOfEngineCamera pauses the script’s Update() event of current engine camera, which is “camera1”.
adminPauseUpdateEventOfEngineCamera