wavelength 1.0.0
Loading...
Searching...
No Matches
NetEndGameScreen Class Reference

The results screen of an online game. More...

#include <netendgamescreen.h>

Inheritance diagram for NetEndGameScreen:
Collaboration diagram for NetEndGameScreen:

Public Member Functions

 ~NetEndGameScreen () override=default
 Destroy the object.
 NetEndGameScreen (DataArray *pData)
 Construct the screen from its script description, with no time running.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button and the end of the entry, and pass on every other message.
void Poll (float fTime) override
 Advance the screen, and end the game once the time has run out.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 End the game when the cross button chooses a button.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start the time once a screen has entered.
Public Member Functions inherited from MultiEndGameScreen
 ~MultiEndGameScreen () override=default
 Destroy the object.
 MultiEndGameScreen (DataArray *pData)
 Construct the screen from its script description.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Fill a row panel per player in the order of the ranks, the song, and the difficulty, and start the dance of each Freq.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Show the screens that follow the game for the choice of the cross button.
Public Member Functions inherited from FreqScreen
 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
void Draw () override
 Draw what goes under each panel, then the panels.
void Exit (UIScreen *pNextScreen, float fTime) override
 Move the projector to the next screen's place and start the exit.
virtual const char * Title ()
 Report the localised title of the screen, the token <name>_TITLE.
virtual void PlayButtonSound (int nButton)
 Play the menu sound of a controller button.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Play the sound of the button that chooses a component.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Choose the component the shortcuts section of the metagame configuration lists for the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Pass on a controller button of a controller the players use, and swallow any other.
Public Member Functions inherited from UIScreen
 UIScreen (DataArray *pData)
 Construct a screen from its script description.
 ~UIScreen () override
 Destroy the screen.
bool Dispatch (Message *pMsg) override
 Offer a message to the manager, then handle it here, then pass a navigation message on.
bool DispatchPriv (Message *pMsg) override
 Follow the transition of a pressed button or a chosen component.
virtual void Print (PrnStream &stream)
 Write a description of the screen, its panels, and its transitions.
void ClearTransitions ()
 Empty the transition table.
void AddTransition (const char *pszComponent, int nButton, const char *pszScreen)
 Append an entry to the transition table.
void AddPanel (UIPanel *pPanel)
 Add a panel to the screen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Follow the transition of a pressed controller button.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Follow the transition of a component chosen with the cross button.
void SetFocus (UIPanel *pPanel)
 Move the focus to a panel.
UIComponent * FindComponent (const char *pszName)
 Find a component on any of the screen's panels.
Transition * FindTransition (UIComponent *pComponent, bool bFail)
 Find the transition of a component.
Transition * FindTransition (int nButton, bool bFail)
 Find the transition of a controller button.
void Load ()
 Load the panels.
void Unload ()
 Unload the panels.
bool IsLoaded ()
 Report whether every panel has loaded.
const char * GetName () const
const char * GetGroup () const
UIPanel * GetFocusPanel () const
UIScreen * GetNextScreen () const
UIScreen * GetPrevScreen () const
const std::map< const char *, UIPanel *, StrLess > & GetPanels () const
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the pool heaps under the tag "MsgSink".
void operator delete (void *pBlock)
 Return a sink to the pool heaps.
virtual ~MsgSink ()
void * operator new (size_t size)
 Allocate from the main heap under the name MsgSink.
void operator delete (void *mem)
 Return memory to its heap.
virtual ~MsgSink ()
 Destroy the sink.

Static Public Member Functions

static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from MultiEndGameScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from FreqScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.
Static Public Member Functions inherited from UIScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.

Additional Inherited Members

Public Attributes inherited from FreqScreen
Vector3 mGizmoOrig
Quat mGizmoRot
Protected Attributes inherited from UIScreen
const char * mName
const char * mGroup
std::map< const char *, UIPanel *, StrLess > mPanels
UIPanel * mFocusPanel
std::vector< Transition > mTransitions
UIScreen * mPrevScreen
UIScreen * mNextScreen
int mForceEntryExit

Detailed Description

The results screen of an online game.

The screen ends the game itself after a time.

The RTTI records the class as deriving from MultiEndGameScreen. The object is 0xa4 bytes and its vtable is at 0x003cd8c8. The metagame registers the class for the screen type fn_end_screen. The time is net_endgame_wait_ms of the metagame section of the system configuration.

Constructor & Destructor Documentation

◆ ~NetEndGameScreen()

NetEndGameScreen::~NetEndGameScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035bea8
Ghidra address:
PAL: 0x003c9a00

◆ NetEndGameScreen()

NetEndGameScreen::NetEndGameScreen ( DataArray * pData)
explicit

Construct the screen from its script description, with no time running.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x00188810
Ghidra address:
PAL: 0x0018ca50

Member Function Documentation

◆ New()

UIScreen * NetEndGameScreen::New ( DataArray * pData)
inlinestatic

Create a screen from its script description.

The metagame registers the routine for the screen type fn_end_screen.

Parameters
pDataThe script description.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x0035bf78
Ghidra address:
PAL: 0x003c9ad0

◆ DispatchPriv()

bool NetEndGameScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a chosen button and the end of the entry, and pass on every other message.

Parameters
pMsgThe message.
Returns
Whether the message was handled.
Ghidra address:
NTSC-U/C: 0x00188900
Ghidra address:
PAL: 0x0018cb40

Reimplemented from MultiEndGameScreen.

◆ Poll()

void NetEndGameScreen::Poll ( float fTime)
overridevirtual

Advance the screen, and end the game once the time has run out.

Parameters
fTimeThe front-end time.
Ghidra address:
NTSC-U/C: 0x00188848
Ghidra address:
PAL: 0x0018ca88

Reimplemented from MultiEndGameScreen.

◆ HandleSelect()

bool NetEndGameScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

End the game when the cross button chooses a button.

Parameters
pMsgThe message.
Returns
The result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x00188990
Ghidra address:
PAL: 0x0018cbd0

◆ HandleTransitionComplete()

bool NetEndGameScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Start the time once a screen has entered.

Parameters
pMsgThe message.
Returns
The result of FreqScreen::HandleTransitionComplete().
Ghidra address:
NTSC-U/C: 0x001889e8
Ghidra address:
PAL: 0x0018cc28

The documentation for this class was generated from the following file: