SetSoundVolume: Difference between revisions
Jump to navigation
Jump to search
Cazomino05 (talk | contribs) |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function is used to change the volume level of the specified [[sound]] element. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setSoundVolume ( element | <syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theSound:''' The [[sound]] element which volume you want to modify. | ||
*'''volume:''' A | *'''volume:''' A floating point number representing the desired volume level. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the sound volume was successfully changed, ''false'' otherwise. | Returns ''true'' if the [[sound]] element volume was successfully changed, ''false'' otherwise. | ||
==Example== | ==Example== |
Revision as of 20:54, 26 December 2008
This function is used to change the volume level of the specified sound element.
Syntax
bool setSoundVolume ( element theSound, float volume )
Required Arguments
- theSound: The sound element which volume you want to modify.
- volume: A floating point number representing the desired volume level.
Returns
Returns true if the sound element volume was successfully changed, false otherwise.
Example
TODO
Click to collapse [-]
Client--TODO
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