SetSoundMaxDistance

2017-08-22T01:31:00Z

Steady: Changed the OOP syntax of the function to the setter instead of the getter.

__NOTOC__
{{Client function}}
Sets a custom [[sound]] max distance at which the sound stops.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundMaxDistance ( element sound, int distance )</syntaxhighlight>
{{OOP||[[sound]]:setMaxDistance|maxDistance|getSoundMaxDistance}}
===Required Arguments===
*'''sound:''' a [[sound]] element.
*'''distance:''' the default value for this is 20
===Returns===
Returns a ''true'' if the max distance was set, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)

function maxdistanceFunc(command, param)
setSoundMaxDistance(sound, tonumber(param))
end
addCommandHandler("setmaxdistance", maxdistanceFunc)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

[[ar:setSoundMaxDistance]]

Multi Theft Auto: Wiki - User contributions [en]

SetSoundMaxDistance