Xordac: Created page with "Stops playing the ambient soundtrack of an area. void AmbientSoundStop( object oArea ); {{DISPLAYTITLE:AmbientSoundStop(object)}} ===Parameters=== ;..."

2017-05-23T12:11:23Z

Created page with "Stops playing the ambient soundtrack of an area. <nwscript> void AmbientSoundStop( object oArea ); </nwscript> {{DISPLAYTITLE:AmbientSoundStop(object)}} ===Parameters=== ;..."

New page

Stops playing the ambient soundtrack of an area.
<nwscript>
void AmbientSoundStop(
object oArea
);
</nwscript>
{{DISPLAYTITLE:AmbientSoundStop(object)}}
===Parameters===
;oArea
:The area that should stop playing its ambient soundtrack.

===Description===
Stops playing oArea's ambient soundtrack.

===Remarks===
The soundtrack will not cut off abruptly. Instead, it will have a short fade out.

Contrast this with [[MusicBackgroundStop]](), which stops playing the area's ambient ''music''.

You can change the ambient soundtrack for the area using [[AmbientSoundChangeDay]]() and [[AmbientSoundChangeNight]]().

To start playing the soundtrack again, use [[AmbientSoundPlay]]().

===Version===
1.22

===Example===
<nwscript>
// This example script will stop the music from playing. If the ambient sound is
// crickets, we could make the crickets fade out when the player gets too close.
// A trigger's OnEnter script:
void main()
{
object oArea = GetArea(OBJECT_SELF);
AmbientSoundStop(oArea);
}
</nwscript>

===See Also===
{| class="seealso"
| width="1px" align="right" valign="top" | functions: 
|[[AmbientSoundChangeDay]], [[AmbientSoundChangeNight]], [[AmbientSoundPlay]]
|} 
----

author: Iskander Merriman
[[Category:Functions]]
[[Category:Area_Functions]]
[[Category:Sound_Effects_Functions]]

AmbientSoundStop - Revision history

Xordac: Created page with "Stops playing the ambient soundtrack of an area. void AmbientSoundStop( object oArea ); {{DISPLAYTITLE:AmbientSoundStop(object)}} ===Parameters=== ;..."