GetSoundPan: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} This function is used to get the pan level of the specified sound element. ==Syntax== <syntaxhighlight lang="lua">float getSoundPan ( element theSound )</co...") |
|||
Line 7: | Line 7: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theSound:''' The [[sound]] element which pan you want to | *'''theSound:''' The [[sound]] element which pan you want to get. | ||
===Returns=== | ===Returns=== |
Revision as of 21:11, 19 December 2013
This function is used to get the pan level of the specified sound element.
Syntax
float getSoundPan ( element theSound )
Required Arguments
- theSound: The sound element which pan you want to get.
Returns
Returns float value with range from -1.0 (left) to 1.0 (right), false otherwise.
Example
Click to collapse [-]
Clientfunction playMusic () local song = playSound('song.mp3') setSoundPan(song, 0.3) outputChatBox("Current pan is "..tostring(getSoundPan(song))) end addCommandHandler("music", playMusic)
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