GetSoundMinDistance

Gets a custom sound Minimum distance at which the sound stops getting louder.

Syntax

int getSoundMinDistance ( element sound )

OOP Syntax Help! I don't understand this!

Method: sound:getMinDistance(...)

Variable: .minDistance

Counterpart: setSoundMinDistance

Required Arguments

• sound: a sound element.

Returns

Returns an integer of the minimum distance, false if invalid arguements where passed.

Example

Click to collapse [-]

Client

local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)

function distanceFunc()
    outputChatBox("Minimum distance: " .. getSoundMinDistance(sound))
end
addCommandHandler("getdistance", distanceFunc)

See Also

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM

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