GetSoundVolume

From Multi Theft Auto: Wiki
Revision as of 15:26, 6 October 2012 by Jaysds1 (talk | contribs) (Removed 'Needs Example')
Jump to navigation Jump to search

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