Get3DSoundScriptIntVariable

Definition

int Get3DSoundScriptIntVariable(string 3DSoundName, string variable)

Description

This function gets the value of the Integer 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 Integer variable defined in the script attached to the 3DSoundName 3D sound.

Return Value

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

Example

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

return_value = 0

function Init()
    return_value = Get3DSoundScriptIntVariable("sound1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value 1 in the script attached to the 3D sound object “sound1”, Get3DSoundScriptIntVariable function returns the value 1.
adminGet3DSoundScriptIntVariable