Discuss this page on this pages [[uiSetSoundtrackMode Talk Page|TalkPage]]

=== uiSetSoundtrackMode ===

^ Syntax | (uiSetSoundtrackMode mode [soundtrackUNID]) |
^ Arguments | mode: The mode to set the track to. |
^ | soundtrackUNID: UNID of the soundtrack. Can be blank to refer to current track. |
^ Returns |  |
^ Category | [[ui functions]], [[soundtrack functions]]|
^ Description | Sets the mode on the soundtrack. |

=== Example ===

<code lisp>(uiSetSoundtrackMode 'missionEndTravel)</code>

Sets the currently playing soundtrack's mode to 'missionEndTravel.

==== Modes ====

**missionEnd** forces the mission track to end, and plays the next track in queue.

**missionEndTravel** forces the mission track to end, and begin travel music.

**missionStart** will play the mission soundtrack.


[[modding:xml:Soundtrack types]]

Return to [[modding:function:UI Functions]] list

Return to [[:Functions]] list