GetSoundMaxDistance: Difference between revisions
Jump to navigation
Jump to search
(created) |
m (Change See Also template) |
||
| (10 intermediate revisions by 9 users not shown) | |||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getSoundMaxDistance ( element sound )</syntaxhighlight> | <syntaxhighlight lang="lua">int getSoundMaxDistance ( element sound )</syntaxhighlight> | ||
{{OOP||[[sound]]:getMaxDistance|maxDistance|setSoundMaxDistance}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' a [[sound]] element. | *'''sound:''' a [[sound]] element. | ||
===Returns=== | ===Returns=== | ||
Returns an ''integer'' of the max distance, ''false'' if invalid | Returns an ''integer'' of the max distance, ''false'' if invalid arguments where passed. | ||
==Example== | ==Example== | ||
| Line 18: | Line 18: | ||
function getmaxdistanceFunc() | function getmaxdistanceFunc() | ||
outputChatBox("Max distance: " .. getSoundMaxDistance(sound)) | |||
end | end | ||
addCommandHandler("getmaxdistance", getmaxdistanceFunc) | addCommandHandler("getmaxdistance", getmaxdistanceFunc) | ||
| Line 25: | Line 25: | ||
==See Also== | ==See Also== | ||
{{ | |||
{{Audio_functions|client}} | |||
[[HU:getSoundMaxDistance]] | |||
[[AR:getSoundMaxDistance]] | |||
[[RO:getSoundMaxDistance]] | |||
[[PT-BR:getSoundMaxDistance]] | |||
Latest revision as of 22:14, 6 September 2024
Gets a custom sound max distance at which the sound stops.
Syntax
int getSoundMaxDistance ( element sound )
OOP Syntax Help! I don't understand this!
- Method: sound:getMaxDistance(...)
- Variable: .maxDistance
- Counterpart: setSoundMaxDistance
Required Arguments
- sound: a sound element.
Returns
Returns an integer of the max distance, false if invalid arguments where passed.
Example
Click to collapse [-]
Clientlocal sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
function getmaxdistanceFunc()
outputChatBox("Max distance: " .. getSoundMaxDistance(sound))
end
addCommandHandler("getmaxdistance", getmaxdistanceFunc)
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