GetSoundVolume
Jump to navigation
Jump to search
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 )
OOP Syntax Help! I don't understand this!
- Method: sound:getVolume(...)
- Variable: .volume
- Counterpart: setSoundVolume
Required Arguments
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", localPlayer, wasted) --add the event handler
Changelog
| Version | Description |
|---|
| 1.3.2 | Added player element to use a players voice |
See Also
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData