GetSkyScriptStringVariable

Definition

string GetSkyScriptStringVariable(string variable)

Description

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

Parameters

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

Return Value

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

Example

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

return_value = ""

function Init()
    return_value = GetSkyScriptStringVariable("a")
end

function Update()

end
Assuming that the variable “a” is defined with the value “hello” in the script attached to the sky object, GetSkyScriptStringVariable function returns the value “hello”.
adminGetSkyScriptStringVariable