VoltAir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Signals | Properties | List of all members
PauseMenu Class Reference

Menu displayed when the game is paused. More...

Inheritance diagram for PauseMenu:
UiComponent KeyNavFocusArea

Signals

void resumeRequested ()
 Emitted when the player chooses to resume the game. More...
 
void changeLevelProgressionRequested ()
 Emitted when the player chooses to return to the main menu. More...
 
void changeLevelRequested ()
 Emitted when the player chooses to return to the level selection menu. More...
 
void showAchievementsRequested ()
 Emitted when the player chooses to show their achievements. More...
 
void signIntoCloudRequested ()
 Emitted when the player chooses to sign-in to Google Play Games Services. More...
 
void quitDialogRequested ()
 Emitted when the player chooses to open the quit 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...
 

Properties

bool signedIntoCloud
 Whether or not the player has signed in to 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...
 

Additional Inherited Members

- 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...
 

Detailed Description

Menu displayed when the game is paused.

The menu allows the player to go to the main menu, level selection menu, sign-in to Google Play Games Services, show achievements, quit, or resume their game.

Note
The sign-in function will be replaced with the show achievements button once signed in.

Member Function Documentation

void PauseMenu::changeLevelProgressionRequested ( )
signal

Emitted when the player chooses to return to the main menu.

void PauseMenu::changeLevelRequested ( )
signal

Emitted when the player chooses to return to the level selection menu.

void PauseMenu::muteBGMRequested ( )
signal

Emitted when the player chooses to mute the background music.

void PauseMenu::quitDialogRequested ( )
signal

Emitted when the player chooses to open the quit ConfirmDialog.

void PauseMenu::resumeRequested ( )
signal

Emitted when the player chooses to resume the game.

void PauseMenu::showAchievementsRequested ( )
signal

Emitted when the player chooses to show their achievements.

void PauseMenu::signIntoCloudRequested ( )
signal

Emitted when the player chooses to sign-in to Google Play Games Services.

void PauseMenu::unmuteBGMRequested ( )
signal

Emitted when the player chooses to unmute the background music.

Property Documentation

bool PauseMenu::bgmMuted

Whether or not the background music is currently muted.

bool PauseMenu::signedIntoCloud

Whether or not the player has signed in to Google Play Games Services.