GetAmbientSoundScriptBoolVariable

Definition

bool GetAmbientSoundScriptBoolVariable(string ambientSoundName, string variable)

Description

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

Parameters

ambientSoundName
Specifies the name of the ambient sound object.

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

Return Value

Returns the value of the Boolean variable defined in the script attached to the ambientSoundName ambient sound object.

Example

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

value = false

function Init()
    value = GetAmbientSoundScriptBoolVariable("sound1", "a")
end

function Update()

end
Assuming that the variable “a” is defined with the value true in the script attached to the ambient sound object “sound1”, GetAmbientSoundScriptBoolVariable function returns the value true.
adminGetAmbientSoundScriptBoolVariable