GetVideoScriptStringVariable

Definition

string GetVideoScriptStringVariable(string videoName, string variable)

Description

This function gets the value of the String 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 String variable defined in the script attached to the videoName video object.

Return Value

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

Example

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

return_value = ""

function Init()
    return_value = GetVideoScriptStringVariable("video1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value “hello” in the script attached to the video object “video1”, GetVideoScriptStringVariable function returns the value “hello”.
adminGetVideoScriptStringVariable