MusicListWML - Revision history

Sergey: Updated MusicListWML with engine limitations and macro references

2019-04-18T12:19:32Z

Updated MusicListWML with engine limitations and macro references

← Older revision		Revision as of 12:19, 18 April 2019
Line 9:		Line 9:
	* ''play_once=yes'' immediately switch to playing this track, but then return to the play list, which is unchanged.		* ''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. This exists to force music changes '''during''' dialog exchange or other [event] which take significant time.		* ''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. This exists to force music changes '''during''' dialog exchange or other [event] which take significant time.
	* ''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_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''. Do not use this key for a [music] tag directly under [scenario] tag, because of the sound engine limitations it will lead to a story screen lag.
	* ''ms_after'' (optional) specifies how many milliseconds to delay after playing this track.		* ''ms_after'' (optional) specifies how many milliseconds to delay after playing this track. Do not use this key for a [music] tag directly under [scenario] tag, because of the sound engine limitations it will lead to a story screen lag.
	* ''shuffle'' {{DevFeature1.13\|0}} (optional, boolean 'yes'/'no') specifies whether the music playlist as a whole should be shuffled or not. Defaults to 'yes'. The last [music] tag to include this attribute dictates the playlist's configuration.		* ''shuffle'' {{DevFeature1.13\|0}} (optional, boolean 'yes'/'no') specifies whether the music playlist as a whole should be shuffled or not. Defaults to 'yes'. The last [music] tag to include this attribute dictates the playlist's configuration.

Line 31:		Line 31:


			== Useful Macros ==
			There are some predefined macros. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].
			* '''{DEFAULT_MUSIC_PLAYLIST}''': Defines a standard playlist.
			* '''{FULL_MUSIC_PLAYLIST}''': Defines a playlist of all tracks.
			* '''{SCENARIO_MUSIC}''': Defines first track that is played when a scenario starts.
			* '''{EXTRA_SCENARIO_MUSIC}''': Use this immediately after the above SCENARIO_MUSIC macro to append extra tracks to the playlist.
			* '''{INTRO_AND_SCENARIO_MUSIC}''': Works as SCENARIO_MUSIC does, except that it allows you to specify the music used for the story screen (if any) as well.
			* '''{LET_INTRO_MUSIC_FINISH}''': Use immediately following INTRO_AND_SCENARIO_MUSIC, to let the intro music finish before switching to scenario music.
			* '''{INCIDENTAL_MUSIC}''': To be played immediately to mark an incident, but not appended to the scenario playlist.
			* '''{REPLACE_SCENARIO_MUSIC}''': Use this in a mid-scenario to replace the current playlist.
			* '''{APPEND_MUSIC}''': Use this immediately after the above REPLACE_SCENARIO_MUSIC macro to append extra tracks to the playlist.

	[[Category: WML Reference]]		[[Category: WML Reference]]
	[[Category:Music]]		[[Category:Music]]

Shadowm: /* the [music] tag */ shuffle

2015-04-17T08:08:34Z

the [music] tag: shuffle

← Older revision		Revision as of 08:08, 17 April 2015
Line 11:		Line 11:
	* ''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_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.		* ''ms_after'' (optional) specifies how many milliseconds to delay after playing this track.
			* ''shuffle'' {{DevFeature1.13\|0}} (optional, boolean 'yes'/'no') specifies whether the music playlist as a whole should be shuffled or not. Defaults to 'yes'. The last [music] tag to include this attribute dictates the playlist's configuration.

	For a list of music tracks you can use in your scenario, see [[Available Music]].		For a list of music tracks you can use in your scenario, see [[Available Music]].

Paŭlo: /* the [music] tag */ link to ActionWML

2011-01-10T20:19:33Z

the [music] tag: link to ActionWML

← Older revision		Revision as of 20:19, 10 January 2011
Line 2:		Line 2:
	== the [music] tag ==		== the [music] tag ==

	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 also part of [[ActionWML]], 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:		Tags describe the music track:

Opensourcejunkie: /* the [music] tag */

2008-09-06T15:18:09Z

the [music] tag

← Older revision		Revision as of 15:18, 6 September 2008
Line 6:		Line 6:
	Tags describe the music track:		Tags describe the music track:
	* ''name'' specifies the music file, relative to '"music/"'. This is compulsory.		* ''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.		* ''append=yes'' specifies this is to be added to the current playlist. Without this, the current playlist is replaced by this track. (Note: if the same track is appended multiple times in a row, it will only play once before moving on to the next (different) track)
	* ''play_once=yes'' immediately switch to playing this track, but then return to the play list, which is unchanged.		* ''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. This exists to force music changes '''during''' dialog exchange or other [event] which take significant time.		* ''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. This exists to force music changes '''during''' dialog exchange or other [event] which take significant time.

Mesilliac: add to Music category, add a link to Available_Music

2008-02-24T23:37:52Z

add to Music category, add a link to Available_Music

← Older revision		Revision as of 23:37, 24 February 2008
Line 11:		Line 11:
	* ''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_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.		* ''ms_after'' (optional) specifies how many milliseconds to delay after playing this track.

			For a list of music tracks you can use in your scenario, see [[Available Music]].

	=== Example ===		=== Example ===
Line 30:		Line 32:

	[[Category: WML Reference]]		[[Category: WML Reference]]
			[[Category:Music]]

Boucman at 11:29, 3 September 2006

2006-09-03T11:29:12Z

← Older revision		Revision as of 11:29, 3 September 2006
Line 1:		Line 1:
	{{WML Tags}}		{{WML Tags}}
	== 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.

Placid: /* the [music] tag */

2006-03-22T00:28:56Z

the [music] tag

← Older revision		Revision as of 00:28, 22 March 2006
Line 1:		Line 1:
			{{WML Tags}}
	== the [music] tag ==		== the [music] tag ==
	{{DevFeature}}		{{DevFeature}}

Rusty: Provide an example

2006-02-22T02:37:38Z

Provide an example

@@ Line 11: / Line 11: @@
 * ''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.
 [[Category: WML Reference]]

Rusty: Clarify the use of "immediate" (ie. it's exceptional).

2006-02-11T01:54:10Z

Clarify the use of "immediate" (ie. it's exceptional).

← Older revision		Revision as of 01:54, 11 February 2006
Line 8:		Line 8:
	* ''append=yes'' specifies this is to be added to the current playlist. Without this, the current playlist is replaced by this track.		* ''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.		* ''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.		* ''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. This exists to force music changes '''during''' dialog exchange or other [event] which take significant time.
	* ''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_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.		* ''ms_after'' (optional) specifies how many milliseconds to delay after playing this track.

Rusty: Mark it as SVN-only

2006-01-30T06:15:45Z

Mark it as SVN-only

← Older revision		Revision as of 06:15, 30 January 2006
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.