====== Music ======

''Reviewed For: SDK 2.1''

Each scenario in Outpost 2 can be tailored to use a specific subset of the available in game music. All music tracks are represented in the ''enum SongIds''. In order to customize the tracks, place an array of ''SongIds'' in the scenario. Then inform the game of the array via the function ''TethysGame::SetMusicPlayList()''.

You can use the function parameter repeatStartIndex on SetMusicPlayList in order to designate the index where repeat play starts. This allows setting some songs that are only played when the scenario is initially started and then not playing these songs later in the scenario.

Below is a table of the names of the MP3 tracks compared to their equivalent SDK enum. The MP3 tracks can be downloaded from the Outpost Universe Outpost 2 downloads page.

^Song MP3 Name^Song Enum^
|Eden & Plymouth 1|songEP41|
|Eden & Plymouth 2|songEP42|
|Eden & Plymouth 3|songEP43|
|Eden & Plymouth 4|songEP51|
|Eden & Plymouth 5|songEP52|
|Eden & Plymouth 6|songEP61|
|Eden & Plymouth 7|songEP62|
|Eden & Plymouth 8|songEP63|
|Eden 1|songEden11|
|Eden 2|songEden21|
|Eden 3|songEden22|
|Eden 4|songEden31|
|Eden 5|songEden32|
|Eden 6|songEden33|
|Plymouth 1|songPlymth11|
|Plymouth 2|songPlymth12|
|Plymouth 3|songPlymth21|
|Plymouth 4|songPlymth22 (main menu music)|
|Plymouth 5|songPlymth31|
|Plymouth 6|songPlymth32|
|Plymouth 7|songPlymth33|
|Static 1|songStatic01|
|Static 2|songStatic02|
|Static 3|songStatic03|
|Static 4|songStatic04 (standard multiplayer theme)|
|Static 5|songStatic05|

===== Related Source Code =====

//TethysGame//
<code cpp>
static void __fastcall SetMusicPlayList(int numSongs, int repeatStartIndex, SongIds* songIdList);
</code>

//Enums.h//
<code cpp>
enum SongIds 
{
    songEden11 = 0,	// 0x0
    songEden21,		// 0x1
    songEden22,		// 0x2
    songEden31,		// 0x3
    songEden32,		// 0x4
    songEden33,		// 0x5
    songEP41,		// 0x6
    songEP42,		// 0x7
    songEP43,		// 0x8
    songEP51,		// 0x9
    songEP52,		// 0xA
    songEP61,		// 0xB
    songEP62,		// 0xC
    songEP63,		// 0xD
    songPlymth11,	// 0xE
    songPlymth12,	// 0xF
    songPlymth21,	// 0x10
    songPlymth22,	// 0x11
    songPlymth31,	// 0x12
    songPlymth32,	// 0x13
    songPlymth33,	// 0x14
    songStatic01,	// 0x15
    songStatic02,	// 0x16
    songStatic03,	// 0x17
    songStatic04,	// 0x18
    songStatic05,	// 0x19
};
</code>

===== Sample Code =====

Set song playlist for scenario
<code cpp>

SongIds songs[] = {
    SongIds::songEden11,
    SongIds::songEden21,
    SongIds::songEden31,
    SongIds::songEden32,
    SongIds::songEden33,
    SongIds::songEP41,
    SongIds::songStatic01
};

int InitProc()
{
    TethysGame::SetMusicPlayList(7, 3, songs);
}

</code>

---- 
 - //Go Back to [[op2_sdk:programming_scenario_dlls|Programming a Scenario]]//\\
 - //Go Back to [[op2_sdk:software_development_kit_sdk|Outpost 2 Mapmaking]]//\\
 - //Go Back to [[outpost_2:outpost_2|Outpost 2 Main page]]//\\
 - //Go Back to [[http://wiki.outpost2.net/doku.php?id=start|Wiki Home Page]]//