GetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (→‎Example: No need for the section)
Line 12: Line 12:
Returns a [[float]] representing the volume level of the [[sound]] element, ''false'' if invalid arguments were passed.
Returns a [[float]] representing the volume level of the [[sound]] element, ''false'' if invalid arguments were passed.


==Example==  
==Example==
TODO
This example creates a sound then outputs the volume for it.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
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
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[Category:Needs Example]]
[[Category:Needs Example]]

Revision as of 15:25, 6 October 2012

This function is used to return the volume level of the specified sound element.

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

See Also

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