SetSoundMinDistance: Difference between revisions
Jump to navigation
Jump to search
Cazomino05 (talk | contribs) mNo edit summary |
mNo edit summary |
||
| (7 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
Sets a custom [[sound | Sets a custom [[sound]] Minimum distance at which the sound stops getting louder. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setSoundMinDistance ( element sound, int distance )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setSoundMinDistance ( element sound, int distance )</syntaxhighlight> | ||
{{OOP||[[sound]]:setMinDistance|minDistance|getSoundMinDistance}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' a [[sound]] element. | *'''sound:''' a [[sound]] element. | ||
*'''distance:''' an integer representing the distance the sound stops getting louder. the default value for this is | *'''distance:''' an integer representing the distance the sound stops getting louder. the default value for this is 5 | ||
===Returns=== | ===Returns=== | ||
Returns a | Returns a ''true'' if the minimum distance was set, ''false'' otherwise. | ||
==Example== | ==Example== | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
- | local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true) | ||
function distanceFunc(command, param) | |||
setSoundMinDistance(sound, tonumber(param)) | |||
end | |||
addCommandHandler("setdistance", distanceFunc) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
| Line 22: | Line 26: | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[PT-BR:setSoundMinDistance]] | |||
[[HU:setSoundMinDistance]] | |||
[[AR:setSoundMinDistance]] | |||
Latest revision as of 02:06, 19 August 2021
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
- 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