GetTerrainScriptBoolVariable

Definition

bool GetTerrainScriptBoolVariable(string variable)

Description

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

Parameters

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

Return Value

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

Example

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

value = false

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

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the terrain object, GetTerrainScriptBoolVariable function returns the value true.
adminGetTerrainScriptBoolVariable