Get3DSoundScriptBoolVariable

Definition

bool Get3DSoundScriptBoolVariable(string 3DSoundName, string variable)

Description

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

Return Value

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

Example

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

return_value = false

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

function Update()

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