HU/getSoundPan

This function is used to get the pan level of the specified sound element.

Syntax

float getSoundPan ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:getPan(...)

Variable: .pan

Counterpart: setSoundPan

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 [-]

Client

function playMusic ()
        local song = playSound('song.mp3')
        setSoundPan(song, 0.3)
        outputChatBox("Current pan is "..tostring(getSoundPan(song)))
end

addCommandHandler("music", playMusic)

See Also

• HU/getRadioChannel
• HU/getRadioChannelName
• HU/getSFXStatus
• HU/getSoundBPM
• HU/getSoundEffects
• HU/getSoundFFTData
• HU/getSoundLength
• HU/getSoundLevelData
• HU/getSoundMaxDistance
• HU/getSoundMetaTags
• HU/getSoundMinDistance
• HU/getSoundPan
• HU/getSoundPosition
• HU/getSoundProperties
• HU/getSoundSpeed
• HU/getSoundVolume
• HU/getSoundWaveData
• HU/isSoundPanningEnabled
• HU/isSoundPaused
• HU/playSFX
• HU/playSFX3D
• HU/playSound
• HU/playSound3D
• HU/playSoundFrontEnd
• HU/setRadioChannel
• HU/setSoundEffectEnabled
• HU/setSoundMaxDistance
• HU/setSoundMinDistance
• HU/setSoundPan
• HU/setSoundPanningEnabled
• HU/setSoundPaused
• HU/setSoundPosition
• HU/setSoundProperties
• HU/setSoundSpeed
• HU/setSoundVolume
• HU/stopSound