GetCameraScriptIntVariable

Definition

int GetCameraScriptIntVariable(string cameraName, string variable)

Description

This function gets the value of the Integer variable defined in the script attached to the cameraName engine camera object.

Parameters

cameraName
Specifies the name of the engine camera object.

variable
Specifies the name of the Integer variable defined in the script attached to the cameraName engine camera.

Return Value

Returns the value of the Integer variable defined in the script attached to the cameraName engine camera object.

Example

--script name is GetCameraScriptIntVariable.lua attached a to game object such as water

return_value = 0

function Init()
    return_value = GetCameraScriptIntVariable("camera1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value 1 in the script attached to the engine camera object “camera1”, GetCameraScriptIntVariable function returns the value 1.
adminGetCameraScriptIntVariable