GetSoundVolume: Difference between revisions

Revision as of 22:48, 4 May 2013

This function is used to return the volume level of the specified sound element. If the element is a player, this function will use the players voice.

Syntax

float getSoundVolume ( element theSound )

Required Arguments

theSound: The sound element which volume you want to return.

Returns

Returns a float representing the volume level of the sound element, false if invalid arguments were passed.

Example

This example creates a sound then outputs the volume for it.

function wasted (killer, weapon, bodypart) 
	local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
	outputChatBox("Wasted Sound volume: "..getSoundVolume(sound)) --outputs to the client the volume of the sound
end
addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler

Changelog

Version	Description

1.3.2

Added player element to use a players voice

@@ Line 3: / Line 3: @@
 This function is used to return the volume level of the specified [[sound]] element.
 {{New_feature|3.0139|1.3.2|
-Use a player element to control a players voice with this function.
+If the element is a player, this function will use the players voice.
 }}
 ==Syntax==
@@ Line 26: / Line 26: @@
 ==Changelog==
 {{ChangelogHeader}}
-{{ChangelogItem|1.3.2|Added player element for voice control}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
 ==See Also==
 {{Client_audio_functions}}