GetSoundVolume: Difference between revisions
Jump to navigation
Jump to search
m (Removed 'Needs Example') |
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| | |||
Use a player element to control a players voice with this function. | |||
}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight> | <syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight> | ||
| Line 21: | Line 23: | ||
addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler | addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Changelog== | |||
{{ChangelogHeader}} | |||
{{ChangelogItem|1.3.2|Added player element for voice control}} | |||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
Revision as of 22:39, 4 May 2013
This function is used to return the volume level of the specified sound element. Use a player element to control a players voice with this function.
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 for voice control |
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd