SetPlayList

Category: Music
Since engine version: 5.1 OC

Description

Sets the play list of pieces of music to be played in random order, if music is activated. The actual number of pieces of music in the playlist is returned, or 0 in network mode.

Syntax

int SetPlayList(string playlist);

Parameter

playlist:
[opt] List of pieces of music to be played. The individual file names are separated with semicolons (";"). Wildcards are expanded. If the parameter is left out, the standard playlist is restored.

Remarks

SetPlayList does not activate music playback when the player has turned the music off. If the player enables music, the new playlist takes effect.
SetPlayList("*.*") is not identical to SetPlayList(). The former activates all music, the latter only those not starting with "@", the standard behavior.
See also: Music
PeterW, 2003-01