GetCameraScriptStringVariable

Definition

string GetCameraScriptStringVariable(string cameraName, string variable)

Description

This function gets the value of the String 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 String variable defined in the script attached to the cameraName engine camera.

Return Value

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

Example

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

return_value = ""

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

function Update()

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