Activates the Menu Mode and plays a given Theme as the menu background music.

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

Syntax

C#
public PsaiResult MenuModeEnter(
	int menuThemeId,
	float menuThemeIntensity
)

Parameters

menuThemeId
Type: System..::..Int32
the id of the theme to play in the background while in menu mode.
menuThemeIntensity
Type: System..::..Single
the static intensity of the menu Theme playback

Return Value

Type: PsaiResult
PsaiResult.OK if successful

Remarks

The Menu Mode is designed for all kinds of in-game menus, where the gameplay is interrupted and frozen In Menu Mode no intensity curve will be applied, so the music holds the intensity-level just like a Continuous Action Theme. When the Player returns to the game, call menuModeLeave() to switch back to the previous state.

See Also