SetAmbientSoundScriptDoubleVariable

Definition

SetAmbientSoundScriptDoubleVariable(string ambientSoundName, string variable, double value)

Description

This function sets the value of the Double variable defined in the script attached to the ambientSoundName ambient sound object to value.

Parameters

ambientSoundName
Specifies the name of the ambient sound object.

variable
Specifies the name of the Double variable defined in the script attached to the ambientSoundName ambient sound.

value
Specifies the Double value for the variable variable.

Example

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

function Init()
    SetAmbientSoundScriptDoubleVariable("sound1", "a", 1.0)
end

function Update()

end
Assuming that the variable “a” is defined in the script attached to the ambient sound object “sound1”, SetAmbientSoundScriptDoubleVariable function sets the  “a” variable to 1.0.
adminSetAmbientSoundScriptDoubleVariable