music

The music namespace controls game music playback. Only one track can play at a time.

See Appendix C — Music for the full list of track IDs.

?music → string

Returns the ID of the currently playing music track, or an empty string if no music is playing.

>`0,0,Current Music = @music@

music.Play(str)

Returns: nothing

Plays the track with the given ID. Replaces any track currently playing.

?loc.begin | loc.loop
  music.Play(temple_0)

music.Stop()

Returns: nothing

Stops all music.

?!string.Equals(music, "")
  music.Stop()

Example — location-based music

?loc.begin | loc.loop
  ?loc = caves
    music.Play(caustic_caves)
  :?loc = temple
    music.Play(temple_0)
  :?loc = deadwood
    music.Play(deadwood_0)
  :
    music.Stop()