Get3DSoundScriptStringVariable

Definition

string Get3DSoundScriptStringVariable(string 3DSoundName, string variable)

Description

This function gets the value of the String variable defined in the script attached to the 3DSoundName 3D sound object.

Parameters

3DSoundName
Specifies the name of the 3D sound object.

variable
Specifies the name of the String variable defined in the script attached to the 3DSoundName 3D sound.

Return Value

Returns the value of the String variable defined in the script attached to the 3DSoundName 3D sound object.

Example

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

return_value = ""

function Init()
    return_value = Get3DSoundScriptStringVariable("sound1""a")
end

function Update()

end
Assuming that the variable “a” is defined with the value “hello” in the script attached to the 3D sound object “sound1”Get3DSoundScriptStringVariable function returns the value “hello”.
adminGet3DSoundScriptStringVariable