User Tools

Site Tools


modding:function:uisetsoundtrackmode

Discuss this page on this pages 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

(uiSetSoundtrackMode 'missionEndTravel)

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.

Soundtrack types

Return to UI Functions list

Return to Functions list

modding/function/uisetsoundtrackmode.txt · Last modified: 2017/01/31 00:41 by xephyr