MusicBattleStop

MusicBattleStop(object)

Stops the currently playing battle track.

void MusicBattleStop(
    object oArea
);

Parameters

oArea

The area affected.

Description

This function terminates playing the currently playing battle track for an area.

Version

1.22

Example

//when used in an area handler such as OnEnter, this causes any
//battle music to stop playing
object oArea = GetArea(OBJECT_SELF);
MusicBattleStop(oArea);

See Also

---

 author: Michael Nork, editor: Jeff Lindsey