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

The main menu, with the solo, multiplayer, online, and options buttons. More...

#include <metamainscreen.h>

Inheritance diagram for MetaMainScreen:
Collaboration diagram for MetaMainScreen:

Public Member Functions

 ~MetaMainScreen () override=default
 Destroy the object.
 MetaMainScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button and a focus change, and pass on every other message.
void Exit (UIScreen *pNextScreen, float fTime) override
 Stop the portal sounds and start the exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry and, when several controllers were in use, reduce the game to the first player.
const char * Title () override
 Report the empty title of the screen.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Set up the game the chosen button of the cross button leads to.
bool HandleFocusChange (UIComponentFocusChangeMsg *pMsg)
 Play the portal sound of the button that receives the focus in the main panel.
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.
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 Poll (float fTime)
 Advance the panels to a time, and finish the exit or the entry once their animations stop.
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

The main menu, with the solo, multiplayer, online, and options buttons.

The RTTI records the class as deriving from FreqScreen. The object is 0x70 bytes and its vtable is at 0x003ceea8. The metagame registers the class for the screen type meta_main_screen, and the front-end description's main screen is one. Its panels are main and help, and its transition table leads from solo_but to main2solofreq, from multi_but to main2multifreq, from freqnet_but to main2netfreq, and from options_but to main_opt. The destructor at 0x0035d410 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~MetaMainScreen()

MetaMainScreen::~MetaMainScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035d410
Ghidra address:
PAL: 0x003cb4e8

◆ MetaMainScreen()

MetaMainScreen::MetaMainScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018d440
Ghidra address:
PAL: 0x00193fa8

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type meta_main_screen.

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

◆ DispatchPriv()

bool MetaMainScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Reimplemented from FreqScreen.

◆ Exit()

void MetaMainScreen::Exit ( UIScreen * pNextScreen,
float fTime )
overridevirtual

Stop the portal sounds and start the exit.

Parameters
pNextScreenThe screen to change to.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x0018d4e8
Ghidra address:
PAL: 0x001943e0

Reimplemented from FreqScreen.

◆ Enter()

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

Start the entry and, when several controllers were in use, reduce the game to the first player.

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

Reimplemented from FreqScreen.

◆ Title()

const char * MetaMainScreen::Title ( )
inlineoverridevirtual

Report the empty title of the screen.

Returns
An empty string.
Ghidra address:
NTSC-U/C: 0x0035d4e8
Ghidra address:
PAL: 0x003cb5c0

Reimplemented from FreqScreen.

◆ HandleSelect()

bool MetaMainScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Set up the game the chosen button of the cross button leads to.

Every button resets the skill level to 1, the tutorial, and the practice mode, and sets the community of the game. The solo and online buttons reduce the game to the first player. The multiplayer button first offers to save a Freq the player changed, through the cur_freq_not_saved screen.

Parameters
pMsgThe message.
Returns
True when the save offer opened, otherwise the result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x0018d5a0
Ghidra address:
PAL: 0x00194498

◆ HandleFocusChange()

bool MetaMainScreen::HandleFocusChange ( UIComponentFocusChangeMsg * pMsg)

Play the portal sound of the button that receives the focus in the main panel.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x0018d8b8
Ghidra address:
PAL: 0x001947b0

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