GetLightScriptBoolVariable

Definition

bool GetLightScriptBoolVariable(string lightName, string variable)

Description

This function gets the value of the Boolean 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 Boolean variable defined in the script attached to the lightName light.

Return Value

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

Example

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

value = false

function Init()
    value = GetLightScriptBoolVariable("light1""a")
end

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the light object “light1”GetLightScriptBoolVariable function returns the value true.
adminGetLightScriptBoolVariable