GetTriggerScriptBoolVariable

Definition

bool GetTriggerScriptBoolVariable(string triggerName, string variable)

Description

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

Parameters

triggerName
Specifies the name of the trigger object.

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

Return Value

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

Example

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

value = false

function Init()
    value = GetTriggerScriptBoolVariable("trigger1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the trigger object “trigger1”, GetTriggerScriptBoolVariable function returns the value true.
adminGetTriggerScriptBoolVariable