GetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}
This function is used to return the volume level of the specified [[sound]] element.
This function is used to return the volume level of the specified [[sound]] element.
{{New_feature|3.0139|1.3.2|
If the element is a player, this function will use the players voice.
If the element is a player, this function will use the players voice.
}}
 
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight>  

Revision as of 08:22, 10 June 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

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundVolume?oldid=36385"