GetVideoScriptBoolVariable

Definition

bool GetVideoScriptBoolVariable(string videoName, string variable)

Description

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

Parameters

videoName
Specifies the name of the video object.

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

Return Value

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

Example

--script name is GetVideoScriptBoolVariable.lua attached a to game object such as light

value = false

function Init()
    value = GetVideoScriptBoolVariable("video1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the video object “video1”, GetVideoScriptBoolVariable function returns the value true.
adminGetVideoScriptBoolVariable