Difference between revisions of "MusicListWML"

From The Battle for Wesnoth Wiki
(simplified immediate=. If too much technical info was cut out, you can add it back, but it was confusing before)
m (Mark it as SVN-only)
Line 1: Line 1:
 
== the [music] tag ==
 
== the [music] tag ==
 +
{{DevFeature}}
  
 
This tag is a subtag of [scenario] and [event] which is used to describe a music track to play.  You can repeat this tag as many times as you like; if you set the ''append'' tag to ''yes'' they will form a playlist from which tracks will be selected at random.
 
This tag is a subtag of [scenario] and [event] which is used to describe a music track to play.  You can repeat this tag as many times as you like; if you set the ''append'' tag to ''yes'' they will form a playlist from which tracks will be selected at random.

Revision as of 06:15, 30 January 2006

the [music] tag

Template:DevFeature

This tag is a subtag of [scenario] and [event] which is used to describe a music track to play. You can repeat this tag as many times as you like; if you set the append tag to yes they will form a playlist from which tracks will be selected at random.

Tags describe the music track:

  • name specifies the music file, relative to '"music/"'. This is compulsory.
  • append=yes specifies this is to be added to the current playlist. Without this, the current playlist is replaced by this track.
  • play_once=yes immediately switch to playing this track, but then return to the play list, which is unchanged.
  • immediate=yes immediately switch to playing this track. Without this, the song will play when the entire [event] is over or the current song ends.
  • ms_before (optional) specifies how many milliseconds to delay before playing this track. Currently this does not apply when the scenario first starts, or with play_once or immediate.
  • ms_after (optional) specifies how many milliseconds to delay after playing this track.