View source for SetSound3DMinMaxDistance

= setSound3DMinMaxDistance =
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.2</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.2 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Changes the attenuation distances of a positional sound owned by the current client resource.

== Syntax ==
<syntaxhighlight lang="lua">
bool setSound3DMinMaxDistance(number sound, number minDistance, number maxDistance)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>sound</code> || <code>number</code> || yes || The resource-owned handle returned by <code>playSound</code> or <code>playSound3D</code>.
|-
| <code>minDistance</code> || <code>number</code> || yes || Full-volume distance in metres, at least 0.01.
|-
| <code>maxDistance</code> || <code>number</code> || yes || Maximum attenuation distance in metres, greater than minDistance and no greater than 10,000.
|}

== Returns ==
Returns <code>true</code> when an owned 3D sound is updated; otherwise returns <code>false</code>.

== Examples ==
Extend the range of an ambient source:
<syntaxhighlight lang="lua" line>
setSound3DMinMaxDistance(ambientSound, 3.0, 90.0)
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* This function returns false for sounds created by <code>playSound</code>.

[[Category:Lua Functions]]
[[Category:Client Functions]]
[[Category:Audio Functions]]