Menu Music And Interface Audio

Thread created primarily to work out best solution for T3D CE.

--------------------------------------------------------------

To get audio to play in a menu (before the server is created) you need to load the datablocks in art/client/init.cs rather than in art/datablocks/audioProfiles.cs.

//at the bottom of init.cs
new SFXProfile(mainMenuTheme)
{
   filename = "art/sound/music/my_tune.ogg";
   description = "AudioMusicLoop2D";
   preload = false;
};

And then at the bottom of art/gui/MainMenu.gui.

function MainMenuGui::onWake(%this)
{
   ...

   //yorks	 
   $maintheme1=sfxCreateSource("mainMenuTheme");
   $maintheme1.play();
   echo("Start Main Menu Theme");
}

function MainMenuGui::onSleep(%this)
{
   //yorks
   $maintheme1.stop();
   echo("Stop Main Menu Theme");
}

Et voila, main menu music that can be controlled from the music volume options in audio options.

Now let's get buttons to click.
You'll need to create a new description for GUI audio in core/scripts/client/audioDescription.cs.

//yorks added!
singleton SFXDescription( InterFace2D : AudioGui )
{
   isLooping         = false;
};

And then back in mainmenu.gui add:

datablock SFXProfile("custom_button_click")
{
   filename = "art/sound/hvystep_mono01.ogg";
   description = "Interface2D";
   preload = true;
};

We need to use mainMenu.gui rather than init.cs to avoid console spam about the GUI/Interface audio not being initialized yet - it works anyway because the audio channel is loaded next, it's just that it gives you 3 lines of console complaint.

Finally, we need to go back and add the command to play the audio to our button. Name the button and then create a function based on an action. As we'll test this with the "select level" button, find the button in mainMenu.gui with the command line:

Command = "Canvas.pushDialog(ChooseLevelDlg);";

And name it: mm_chooseLevel

new GuiButtonCtrl(mm_chooseLevel) {
         canSaveDynamicFields = "0";
         Enabled = "1";
         isContainer = "0";
         Profile = "GuiMenuButtonProfile";
         HorizSizing = "relative";
         VertSizing = "bottom";
         Position = "9 114";
         Extent = "289 75";
         MinExtent = "8 8";
         canSave = "1";
         isDecoy = "0";
         Visible = "1";
         Command = "Canvas.pushDialog(ChooseLevelDlg);";
         tooltipprofile = "GuiToolTipProfile";
         hovertime = "1000";
         text = "Play";
         groupNum = "-1";
         buttonType = "PushButton";
         useMouseEvents = "1";
      };

Then create the function.

function mm_chooseLevel::onClick(%this)
{
   sfxPlayOnce("custom_button_click");
   echo("Choose Level Button Clicked");
}

Stock Problem:
Now there is a problem with this - and that is when you've loaded a level and then quit back to mainMenu, the Interface Audio Channel gets disabled again. Music works fine, but interface/gui audio is switched off. So this needs fixing.

Remember: 2D audio should be stereo, 3D audio should be Mono!