GetGUIButtonScriptBoolVariable

Definition

bool GetGUIButtonScriptBoolVariable(string GUIName, string buttonName, string variable)

Description

This function gets the value of the Boolean variable defined in the script attached to the buttonName button that belongs to GUIName GUI.

Parameters

GUIName
Specifies the the name of the GUI to which the buttonName button belongs.

buttonName
Specifies the the name of the button that belongs to GUIName GUI.

variable
Specifies the name of the Boolean variable defined in the script attached to the buttonName button.

Return Value

Returns the value of the Boolean variable defined in the script attached to the buttonName button that belongs to GUIName GUI.

Example

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

value = false

function Init()
    value = GetGUIButtonScriptBoolVariable("gui_pack1_button", "PlayGame", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the button object “PlayGame” that belongs to “gui_pack1_button” GUI , GetGUIButtonScriptBoolVariable function returns the value true.
adminGetGUIButtonScriptBoolVariable