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

Screen that ranks the players of a game of several players, one row panel per player, with each Freq dancing to its outcome. More...

#include <multiendgamescreen.h>

Inheritance diagram for MultiEndGameScreen:
Collaboration diagram for MultiEndGameScreen:

Public Member Functions

 ~MultiEndGameScreen () override=default
 Destroy the object.
 MultiEndGameScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button, and pass on every other message.
void Poll (float fTime) override
 Show the winner movie at the position of the song.
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 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

Screen that ranks the players of a game of several players, one row panel per player, with each Freq dancing to its outcome.

The RTTI records the class as deriving from FreqScreen. The object is 0xa0 bytes and its vtable is at 0x003cea80. A row panel is m_g_end_<row>_<layout>, where the layout is tie when several players won and the number of players otherwise. The destructor at 0x0035df00 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~MultiEndGameScreen()

MultiEndGameScreen::~MultiEndGameScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035df00
Ghidra address:
PAL: 0x003cbfe0

◆ MultiEndGameScreen()

MultiEndGameScreen::MultiEndGameScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001952b0
Ghidra address:
PAL: 0x0019c680

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool MultiEndGameScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a chosen button, and pass on every other message.

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

Reimplemented from FreqScreen.

Reimplemented in NetEndGameScreen.

◆ Poll()

void MultiEndGameScreen::Poll ( float fTime)
overridevirtual

Show the winner movie at the position of the song.

Parameters
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00195348
Ghidra address:
PAL: 0x0019c718

Reimplemented from UIScreen.

Reimplemented in NetEndGameScreen.

◆ Enter()

void MultiEndGameScreen::Enter ( UIScreen * pPrevScreen,
float fTime )
overridevirtual

Fill a row panel per player in the order of the ranks, the song, and the difficulty, and start the dance of each Freq.

Parameters
pPrevScreenThe screen this one replaces, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001953d0
Ghidra address:
PAL: 0x0019c7a0

Reimplemented from FreqScreen.

◆ HandleSelect()

bool MultiEndGameScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Show the screens that follow the game for the choice of the cross button.

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

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