GetSoundVolume: 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 return the volume level of the specified [[sound]] element. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">float getSoundVolume ( element | <syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theSound:''' The [[sound]] element which volume you want to return. | ||
===Returns=== | ===Returns=== | ||
Returns a | Returns a [[float]] representing the volume level of the [[sound]] element, ''false'' if invalid arguments were passed. | ||
==Example== | ==Example== | ||
Revision as of 20:55, 26 December 2008
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
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