SetSoundPan: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Fixed a typo) |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Needs Checking|3D sounds are supposed to pan automatically deppending on the camera position, so how does this | {{Needs Checking|3D sounds are supposed to pan automatically deppending on the camera position, so how does this function work with 3D sounds? --[[User:AlexTMjugador|AlexTMjugador]] ([[User talk:AlexTMjugador|talk]]) 10:09, 25 May 2014 (UTC)}} | ||
This function is used to change the pan level of the specified [[sound]] element. | This function is used to change the pan level of the specified [[sound]] element. |
Revision as of 10:10, 25 May 2014
This article needs checking. | |
Reason(s): 3D sounds are supposed to pan automatically deppending on the camera position, so how does this function work with 3D sounds? --AlexTMjugador (talk) 10:09, 25 May 2014 (UTC) |
This function is used to change the pan level of the specified sound element.
Syntax
bool setSoundPan ( element theSound, float pan )
Required Arguments
- theSound: The sound element which pan you want to modify.
- pan: A floating point number representing the desired pan level. Range is from -1.0 (left) to 1.0 (right)
Returns
Returns true if the sound element pan was successfully changed, false otherwise.
Example
Click to collapse [-]
Clientfunction playMusic () local left = playSFX("genrl", 75, 6, true) -- Play loading theme music local right = playSFX("genrl", 75, 7, true) setSoundPan(left, -1) -- switch the first music to left channel setSoundPan(right, 1) -- switch the second music to right channel end addCommandHandler("music", playMusic) -- add the command handler
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