GetSkyScriptBoolVariable

Definition

bool GetSkyScriptBoolVariable(string variable)

Description

This function gets the value of the Boolean variable defined in the script attached to the sky object.

Parameters

variable
Specifies the name of the Boolean variable defined in the script attached to the sky object.

Return Value

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

Example

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

value = false

function Init()
    value = GetSkyScriptBoolVariable("a")
end

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the sky object, GetSkyScriptBoolVariable function returns the value true.
adminGetSkyScriptBoolVariable