/// <summary> /// Ends the current Theme and directly returns to the most recently triggered Basic Mood. /// </summary> /// <remarks> /// The transition to the Basic Mood will be interrupted by any call to TriggerMusicTheme(). /// If you prefer to let the music keep silent for some time before playing the last Basic Mood again, /// use GoToRest(). /// </remarks> /// <param name="immediately">true: quick fadeout, false: play an End-Segment</param> /// <returns> /// <list type="table"> /// <item> /// <term>"PsaiResult.OK</term> /// <description> if successful</description> /// </item> /// <item> /// <term>"PsaiResult.initialization_error</term> /// <description>psai has not been initialized correctly. See psai.log for more information.</description> /// </item> /// <item> /// <term>"PsaiResult.unknown_theme</term> /// <description>the requested Theme does not exist in the current soundtrack</description> /// </item> /// <item> /// <term>"PsaiResult.commandIgnoredMenuModeActive</term> /// <description>the command was ignored, call <see cref="MenuModeLeave">MenuModeLeave()</see> first.</description> /// </item> /// <item> /// <term>"PsaiResult.commandIgnored</term> /// <description>the Basic Mood is already playing</description> /// </item> /// </list> /// </returns> public PsaiResult ReturnToLastBasicMood(bool immediately) { return(m_logik.ReturnToLastBasicMood(immediately)); }