LevelSelectionMenu Class Reference

Menu which allows the player to choose which level they want to enter. More...

Inheritance diagram for LevelSelectionMenu:

Signals
void	playLevelRequested (LevelProgression levelProgression, string levelName)
	Emitted when the player has chosen a level to play. More...
void	signIntoCloudRequested ()
	Emitted when a request to Google Play Games Services has been issued. More...
void	showAchievementsRequested ()
	Emitted when requesting the Google Play Games Services' achievement view. More...
void	quitDialogRequested ()
	Emitted when the player chooses to quit and is about to be shown a ConfirmDialog. More...
void	muteBGMRequested ()
	Emitted when the player chooses to mute the background music. More...
void	unmuteBGMRequested ()
	Emitted when the player chooses to unmute the background music. More...
Signals inherited from UiComponent
void	showCompleted ()
	Emitted when the UiComponent has completely shown. More...
void	hideCompleted ()
	Emitted when the UiComponent has completely hidden. More...
Signals inherited from KeyNavFocusArea
void	pressed ()
	Emitted when this area receives a button press. More...
void	released ()
	Emitted when this area receives a button release. More...
void	escaped ()
	Emitted when a back navigation event occurs. More...

Public Member Functions
void	showForProgression (LevelProgression levelProgression, int showDuration)
	Reveals the level progession over the specified duration. More...
void	onPlayerDataChanged ()
	Notifies the LevelSelectionMenu when the player data profile has been updated with new data. More...
Public Member Functions inherited from UiComponent
void	show (int time)
	Shows the UiComponent over time milliseconds. More...
void	hide (int time)
	Hides the UiComponent over time milliseconds. More...

Properties
LevelProgressionList	levelProgressions
	Map of all levels nested in their environments. More...
int	transitionDuration
	Duration of transitions in milliseconds. More...
bool	signedIntoCloud
	Whether or not the user has signed into Google Play Games Services. More...
bool	bgmMuted
	Whether or not the background music is currently muted. More...
Properties inherited from UiComponent
string	showState
	State transitioned to when show() is called. More...
string	hideState
	State transitioned to when hide() is called. More...
int	showDuration
	Time, in milliseconds, that the UiComponent takes to show. More...
int	hideDuration
	Time, in milliseconds, that the UiComponent takes to hide. More...
bool	showing
	Whether or not the UiComponent is shown or is transitioning to the showState. More...
bool	shouldGainFocus
	Whether or not the UiComponent should gain focus when shown. More...
Item	returnFocusTo
	Item that the component returns focus to if this UiComponent gained focus previously. More...
Properties inherited from KeyNavFocusArea
Item	focusUp
	Item to transfer focus to upon an "up" press. More...
Item	focusDown
	Item to transfer focus to upon an "down" press. More...
Item	focusLeft
	Item to transfer focus to upon an "left" press. More...
Item	focusRight
	Item to transfer focus to upon an "right" press. More...
bool	captureBackNavigation
	Whether or not the back button event is handled. More...
int	backNavigationMode
	Mode that determines what keys behave as back buttons. More...

Detailed Description

Menu which allows the player to choose which level they want to enter.

Locked cards will not allow players to enter that environment or level until the previous one has be completed. This menu navigates through states to allow the player filter what type of level they wish to play. The progression menu subdivides into single player or multiplayer progressions. Then, an environment is chosen to select the type of setting for the level. Lastly, the specific level is selected. The hidden state is used to hide and disable all cards.

Member Function Documentation

void LevelSelectionMenu::muteBGMRequested ( )

signal

Emitted when the player chooses to mute the background music.

void LevelSelectionMenu::onPlayerDataChanged

(

)

Notifies the LevelSelectionMenu when the player data profile has been updated with new data.

void LevelSelectionMenu::playLevelRequested ( LevelProgression  levelProgression, string  levelName  )

signal

Emitted when the player has chosen a level to play.

void LevelSelectionMenu::quitDialogRequested ( )

signal

Emitted when the player chooses to quit and is about to be shown a ConfirmDialog.

void LevelSelectionMenu::showAchievementsRequested ( )

signal

Emitted when requesting the Google Play Games Services' achievement view.

void LevelSelectionMenu::showForProgression	(	LevelProgression	levelProgression,
		int	showDuration
	)

Reveals the level progession over the specified duration.

Parameters

levelProgression	Ordered list of levels to complete
showDuration	Time to reveal the menu

void LevelSelectionMenu::signIntoCloudRequested ( )

signal

Emitted when a request to Google Play Games Services has been issued.

void LevelSelectionMenu::unmuteBGMRequested ( )

signal

Emitted when the player chooses to unmute the background music.

Property Documentation

bool LevelSelectionMenu::bgmMuted

Whether or not the background music is currently muted.

LevelProgressionList LevelSelectionMenu::levelProgressions

Map of all levels nested in their environments.

bool LevelSelectionMenu::signedIntoCloud

Whether or not the user has signed into Google Play Games Services.

int LevelSelectionMenu::transitionDuration

Duration of transitions in milliseconds.