SetSoundMinDistance
Jump to navigation
Jump to search
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 5
Returns
Returns a true if the minimum distance was set, false otherwise.
Example
Click to collapse [-]
Clientlocal 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
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData