예제 #1
0
 /// <summary>
 /// Deactivates/reactivates the automatic decrease of the dynamic Intensity while the current Theme is playing.
 /// </summary>
 /// <remarks>
 /// Calling HoldCurrentIntensity(true) will keep the intensity on the current level while the current theme is playing.
 /// The automatic decrease will continue as soon as holdCurrentIntensity(false) is called, or when the playing theme is
 /// interrupted or forced to end, e.g. by calling StopMusic() or ReturnToBase(). Triggering the same theme again will change
 /// the constant intensity to the newly triggered intensity, but will not result in reactivating the automatic decrease.
 /// Note: Calls to holdCurrentIntensity() will be ignored while in Menu Mode or in Cutscene Mode. Call MenuModeLeave() or CutsceneLeave() first.
 /// </remarks>
 /// <param name="hold">pass true to hold the Intensity, false to reactivate the automatic decrease.</param>
 /// <returns>
 ///  <list type="table">
 ///    <item>
 ///      <term>"PsaiResult.OK</term>
 ///      <description> if successful</description>
 ///    </item>
 ///    <item>
 ///      <term>"PsaiResult.commandIgnoredr</term>
 ///      <description>ignored because the intensity is already being held</description>
 ///    </item>
 ///    <item>
 ///      <term>"PsaiResult.commandIgnoredMenuModeActive</term>
 ///      <description>the command was ignored, call <see cref="MenuModeLeave">MenuModeLeave()</see> first.</description>
 ///    </item>
 ///    <item>
 ///      <term>"PsaiResult.commandIgnoredCutsceneActive</term>
 ///      <description>the command was ignored, call <see cref="CutSceneLeave">CutSceneLeave()</see> first.</description>
 ///    </item>
 /// </list>
 /// </returns>
 public PsaiResult HoldCurrentIntensity(bool hold)
 {
     return(m_logik.HoldCurrentIntensity(hold));
 }