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

Displays the results of a multiplayer game. More...

Inheritance diagram for MultiPlayerScoringScreen:
UiComponent KeyNavFocusArea

Signals

void startMenuRequested ()
 Emitted when the start menu is requested. More...
 
void replayLevelRequested ()
 Emitted when a player has chosen to replay the level. More...
 
void signIntoCloudRequested ()
 Emitted when a player tries to sign-in to the cloud. More...
 
void showAchievementsRequested ()
 Emitted when a player requests the Google Play Games Services achievements be shown. 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 onPlayerScoreChanged (int playerId, int score)
 Updates the gauge of the player when their score changes. More...
 
void setPlayerActivation (int playerId, bool active)
 Called to either show or hide a player gauge. 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

int completionThreshold
 Number of Snowflakes needed by a single player to complete the game. More...
 
bool gameCompleted
 Whether or not the game has completed. More...
 
bool signedIntoCloud
 Whether or not a player has signed into the cloud. 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

Displays the results of a multiplayer game.

Member Function Documentation

void MultiPlayerScoringScreen::muteBGMRequested ( )
signal

Emitted when the player chooses to mute the background music.

void MultiPlayerScoringScreen::onPlayerScoreChanged ( int  playerId,
int  score 
)

Updates the gauge of the player when their score changes.

Parameters
playerIdId of the player whose score changed
scoreUpdated score of the player
void MultiPlayerScoringScreen::replayLevelRequested ( )
signal

Emitted when a player has chosen to replay the level.

void MultiPlayerScoringScreen::setPlayerActivation ( int  playerId,
bool  active 
)

Called to either show or hide a player gauge.

Parameters
playerIdId of the player whose gauge needs updating
activeWhether or not that gauge should be shown
void MultiPlayerScoringScreen::showAchievementsRequested ( )
signal

Emitted when a player requests the Google Play Games Services achievements be shown.

void MultiPlayerScoringScreen::signIntoCloudRequested ( )
signal

Emitted when a player tries to sign-in to the cloud.

void MultiPlayerScoringScreen::startMenuRequested ( )
signal

Emitted when the start menu is requested.

void MultiPlayerScoringScreen::unmuteBGMRequested ( )
signal

Emitted when the player chooses to unmute the background music.

Property Documentation

bool MultiPlayerScoringScreen::bgmMuted

Whether or not the background music is currently muted.

int MultiPlayerScoringScreen::completionThreshold

Number of Snowflakes needed by a single player to complete the game.

bool MultiPlayerScoringScreen::gameCompleted

Whether or not the game has completed.

bool MultiPlayerScoringScreen::signedIntoCloud

Whether or not a player has signed into the cloud.