Deactivates/reactivates the automatic decrease of the dynamic Intensity while the current Theme is playing.

Namespace: psai.net
Assembly: psaiCoreDotNet (in psaiCoreDotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
public PsaiResult HoldCurrentIntensity(
	bool hold
)

Parameters

hold
Type: System..::..Boolean
pass true to hold the Intensity, false to reactivate the automatic decrease.

Return Value

Type: PsaiResult
"PsaiResult.OK if successful
"PsaiResult.commandIgnoredrignored because the intensity is already being held
"PsaiResult.commandIgnoredMenuModeActivethe command was ignored, call MenuModeLeave() first.
"PsaiResult.commandIgnoredCutsceneActivethe command was ignored, call CutSceneLeave() first.

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.

See Also