GetMainCharacterScriptStringVariable

Definition

string GetMainCharacterScriptStringVariable(string variable)

Description

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

Parameters

variable
Specifies the name of the String variable defined in the script attached to the main character.

Return Value

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

Example

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

return_value = ""

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

function Update()

end
Assuming that the variable “a” is defined with the value “hello” in the script attached to the main character object, GetMainCharacterScriptStringVariable function returns the value “hello”.
adminGetMainCharacterScriptStringVariable