GetSoundMinDistance: Difference between revisions
Jump to navigation
Jump to search
m (Change See Also template) |
|||
| (8 intermediate revisions by 8 users not shown) | |||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getSoundMinDistance ( element sound )</syntaxhighlight> | <syntaxhighlight lang="lua">int getSoundMinDistance ( element sound )</syntaxhighlight> | ||
{{OOP||[[sound]]:getMinDistance|minDistance|setSoundMinDistance}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' a [[sound]] element. | *'''sound:''' a [[sound]] element. | ||
| Line 12: | Line 12: | ||
Returns an ''integer'' of the minimum distance, ''false'' if invalid arguements where passed. | Returns an ''integer'' of the minimum distance, ''false'' if invalid arguements where passed. | ||
==Example== | |||
<section name="Client" class="client" show="true"> | |||
<syntaxhighlight lang="lua"> | |||
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true) | |||
function distanceFunc() | |||
outputChatBox("Minimum distance: " .. getSoundMinDistance(sound)) | |||
end | |||
addCommandHandler("getdistance", distanceFunc) | |||
</syntaxhighlight> | |||
</section> | |||
==See Also== | ==See Also== | ||
{{ | {{Audio_functions|client}} | ||
[[HU:getSoundMinDistance]] | |||
[[AR:getSoundMinDistance]] | [[AR:getSoundMinDistance]] | ||
[[RO:getSoundMinDistance]] | |||
[[PT-BR:getSoundMinDistance]] | |||
Latest revision as of 22:15, 6 September 2024
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 [-]
Clientlocal 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
- 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