Pair: setSoundPanningEnabled

This function checks whether panning is enabled in a sound element or not.

Tip

Although this function works in no-3D sounds (those created by playSound), it only makes sense to use it with 3D sounds (created by playSound3D). Please refer to setSoundPanningEnabled for a explanation of what this property does.

OOP Syntax Help! I don't understand this!

• Method: sound:isPanningEnabled(...)
• Variable: .panningEnabled

Syntax

bool isSoundPanningEnabled ( sound theSound )

Required Arguments

• theSound: A valid sound element.

Returns

• bool: result

Returns true if the sound is valid and it has panning enabled, false if it does not or is not valid.

Code Examples

Example 1 Example 2 (OOP)

client

This example plays a xy.mp3 file in the root folder of the resource which contains it at the center of the map, and proves that by default a sound enables panning by outputting the result of this function to the chatbox right after creating it. Then it disables the panning of the sound.

local function testPanning()
    -- Create the sound and output the panning property state
    local sound = playSound3D("xy.mp3", 0, 0, 0)
    outputChatBox("By default, the sound has its panning " .. (isSoundPanningEnabled(sound) and "enabled" or "disabled"))
    -- Disable the panning and ouput a fact
    setSoundPanningEnabled(sound, false)
    outputChatBox("The sound panning was disabled, so it won't annoy you when the camera it's in a side anymore!", 0, 255, 0)
end
addEventHandler("onClientResourceStart", resourceRoot, testPanning)

client

OOP Required

This example plays a xy.mp3 file in the root folder of the resource which contains it at the center of the map, and proves that by default a sound enables panning by outputting the result of this function to the chatbox right after creating it. Then it disables the panning of the sound.

local function testPanning()
    -- Create the sound and output the panning property state
    local sound = Sound3D("xy.mp3", 0, 0, 0)
    outputChatBox("By default, the sound has its panning " .. (sound.panningEnabled and "enabled" or "disabled"))
    -- Disable the panning and ouput a fact
    sound.panningEnabled = false
    outputChatBox("The sound panning was disabled, so it won't annoy you when the camera it's in a side anymore!", 0, 255, 0)
end
addEventHandler("onClientResourceStart", resourceRoot, testPanning)

See Also

Audio Functions

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

Audio Elements

• sound

Reference

• Scripting Functions