Menu Music

Updated for version 3.38.

Module Definition

The module is inherited from ItemModuleBase. So base parameters can be found there.

This modules creates a menu track.

Module name

The name of the module you use as the meta of the module definition is 'MenuMusic' or 'MenuMusicModule' if _force_search is set to true in the module definition.

XML Structure

<MenuMusic id source start_source volume/>

<MenuMusic ...>

Parameter	Type	Description
id	String	The ID of the track. This has to be unique
source	String	The path to the .ogg file that the track should play
start_source	String	Optional path to sound to play before playing source
volume	Float	The volume of the music (from 0 to 1)

Example

This example is what you would put inside your main node within your mod config

<MenuMusic id="my_menu_music_name" source="sounds/menu.ogg"/>

This will add the track. You will still need to localize the name of the track. In this case menu_jukebox_my_menu_music_name and menu_jukebox_screen_my_menu_music_name will need to be localized.

Template

Download template here: https://modworkshop.net/mydownloads.php?action=view_down&did=21651

Functions

Get

Function	Return Type	Description
MakeBuffer(String source)	XAudioBuffer	Called by RegisterHook to create an XAudio buffer