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

The title screen, which waits for a player to press a button and otherwise starts the attract demo. More...

#include <metastartscreen.h>

Inheritance diagram for MetaStartScreen:
Collaboration diagram for MetaStartScreen:

Public Member Functions

 ~MetaStartScreen () override=default
 Destroy the object.
 MetaStartScreen (DataArray *pData)
 Construct the screen from its script description, with no attract time.
bool DispatchPriv (Message *pMsg) override
 Arm the attract demo once the screen has entered, and pass on the controller buttons.
void Poll (float fTime) override
 Advance the screen, follow the music with the logo animation, and start the attract demo when its time has passed.
void Exit (UIScreen *pNextScreen, float fTime) override
 Disarm the attract demo and start the exit.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Blank the version text, find the logo animation, and start the entry.
const char * Title () override
 Report the title of the screen, which has none.
void LaunchAttract ()
 Start the next song of attract_songs as a demo, when attract_enabled is set.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Set the attract time once the screen has entered, then follow a shortcut.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Play the choice sound for the cross or START button of the first controller, then pass the button on.
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 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 title screen, which waits for a player to press a button and otherwise starts the attract demo.

The RTTI records the class as deriving from FreqScreen. The object is 0x80 bytes and its vtable is at 0x003cef08. The metagame registers the class for the screen type meta_start_screen, and the front-end description's start screen is one. Its panels are logo and logo_start, and its transition table leads to the main menu.

Once the screen has entered, the attract time is set from the attract_delay_ms setting of the metagame configuration, or from attract_short_delay_ms after a demo. When the system clock passes it, the next song of attract_songs starts as a demo. The destructor at 0x0035d328 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~MetaStartScreen()

MetaStartScreen::~MetaStartScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035d328
Ghidra address:
PAL: 0x003cb400

◆ MetaStartScreen()

MetaStartScreen::MetaStartScreen ( DataArray * pData)
explicit

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

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018cc68
Ghidra address:
PAL: 0x001937d0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type meta_start_screen.

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

◆ DispatchPriv()

bool MetaStartScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Arm the attract demo once the screen has entered, and pass on the controller buttons.

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

Reimplemented from FreqScreen.

◆ Poll()

void MetaStartScreen::Poll ( float fTime)
overridevirtual

Advance the screen, follow the music with the logo animation, and start the attract demo when its time has passed.

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

Reimplemented from UIScreen.

◆ Exit()

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

Disarm the attract demo and start the exit.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Blank the version text, find the logo animation, and start the entry.

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

Reimplemented from FreqScreen.

◆ Title()

const char * MetaStartScreen::Title ( )
inlineoverridevirtual

Report the title of the screen, which has none.

Returns
An empty string.
Ghidra address:
NTSC-U/C: 0x0035d400
Ghidra address:
PAL: 0x003cb4d8

Reimplemented from FreqScreen.

◆ LaunchAttract()

void MetaStartScreen::LaunchAttract ( )

Start the next song of attract_songs as a demo, when attract_enabled is set.

The players are the first player with their own profile, or a player with the default name, and default players up to the song's num_players. The screen then changes to pre_launchpad2launchseq.

Ghidra address:
NTSC-U/C: 0x0018cee8
Ghidra address:
PAL: 0x00193a50

◆ HandleTransitionComplete()

bool MetaStartScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Set the attract time once the screen has entered, then follow a shortcut.

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

◆ HandleJoypad()

bool MetaStartScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Play the choice sound for the cross or START button of the first controller, then pass the button on.

A button is swallowed while the screen changes.

Parameters
pMsgThe message of the button.
Returns
Whether the button was handled.
Ghidra address:
NTSC-U/C: 0x0018d328
Ghidra address:
PAL: 0x00193e90

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