SetSoundMinDistance

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

Syntax

bool setSoundMinDistance ( element sound, int distance )

OOP Syntax Help! I don't understand this!

Method: sound:setMinDistance(...)

Variable: .minDistance

Counterpart: getSoundMinDistance

Required Arguments

• sound: a sound element.
• distance: an integer representing the distance the sound stops getting louder. the default value for this is 1

Returns

Returns a true if the minimum distance was set, false otherwise.

Example

Click to collapse [-]

Client

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

function distanceFunc(command, param)
  setSoundMinDistance(sound, tonumber(param))
end
addCommandHandler("setdistance", distanceFunc)

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