GetTerrainScriptStringVariable

Definition

string GetTerrainScriptStringVariable(string variable)

Description

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

Parameters

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

Return Value

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

Example

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

return_value = ""

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

function Update()

end
Assuming that the variable “a” is defined with the value “hello” in the script attached to the terrain object, GetTerrainScriptStringVariable function returns the value “hello”.
adminGetTerrainScriptStringVariable