GetLightScriptIntVariable

Definition

int GetLightScriptIntVariable(string lightName, string variable)

Description

This function gets the value of the Integer variable defined in the script attached to the lightName light object.

Parameters

lightName
Specifies the name of the light object.

variable
Specifies the name of the Integer variable defined in the script attached to the lightName light.

Return Value

Returns the value of the Integer variable defined in the script attached to the lightName light object.

Example

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

return_value = 0

function Init()
    return_value = GetLightScriptIntVariable("light1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value 1 in the script attached to the light object “light1”, GetLightScriptIntVariable function returns the value 1.
adminGetLightScriptIntVariable