Pair: setSoundPan

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

OOP Syntax Help! I don't understand this!

• Method: sound:getPan(...)
• Variable: .pan

Syntax

float|false getSoundPan ( sound/player theSound )

Required Arguments

• theSound: The sound element which pan you want to get.

Returns

• float|false: pan

Returns float value with range from -1.0 (left) to 1.0 (right), false otherwise.

Code Examples

Example 1 Example 2 (OOP)

client

local function playMusic()
    local song = playSound("song.mp3")
    setSoundPan(song, -1)
    outputChatBox("Current pan is " .. getSoundPan(song))
end
addCommandHandler("music", playMusic)

client

OOP Required

local function playMusic()
    local song = Sound("song.mp3")
    song.pan = -1
    outputChatBox("Current pan is " .. song.pan)
end
addCommandHandler("music", playMusic)

See Also

Audio Functions

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

Audio Elements

• sound

Reference

• Scripting Functions