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

The arena menu. More...

#include <metaarenascreen.h>

Inheritance diagram for MetaArenaScreen:
Collaboration diagram for MetaArenaScreen:

Public Member Functions

 ~MetaArenaScreen () override=default
 Destroy the object.
 MetaArenaScreen (DataArray *pData)
 Construct the screen from its script description, with no pending change.
bool DispatchPriv (Message *pMsg) override
 Route a chosen button, a focus change, and a controller button, and pass on every other message.
void Poll (float fTime) override
 Advance the screen, and change to mPendingScreen once the song preview plays.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enable the arenas that have songs, grey out the locked ones, and focus an arena, then start the entry.
const char * Title () override
 Report the title of the screen, the localised title with the mode and the difficulty.
void UpdateBand (UIComponent *pArena, UIPanel *pPanel)
 List the songs of an arena that receives the focus in the s_g_sel_arena panel.
bool HandleFocusChange (UIComponentFocusChangeMsg *pMsg)
 List the songs of the arena that receives the focus, and play the wheel sound when the focus moves to another arena than Tutorial.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Choose the arena of a button that is not greyed out with the cross button.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Swallow buttons while the screen changes, and go back to the skill menu with the triangle 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 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 arena menu.

It lists the arenas and the songs of the arena with the focus.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003ceba0. The metagame registers the class for the screen type meta_arena_screen, and the front-end description's s_g_sel_arena screen is one. The s_g_sel_arena panel has a button for each arena, the first being Tutorial, and the s_g_sel_arena_band panel lists the songs of the arena with the focus. Choosing an arena waits for the song preview to play before the screen changes. The destructor at 0x0035dc38 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~MetaArenaScreen()

MetaArenaScreen::~MetaArenaScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035dc38
Ghidra address:
PAL: 0x003cbd10

◆ MetaArenaScreen()

MetaArenaScreen::MetaArenaScreen ( DataArray * pData)
explicit

Construct the screen from its script description, with no pending change.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001916e0
Ghidra address:
PAL: 0x001989f8

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type meta_arena_screen.

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

◆ DispatchPriv()

bool MetaArenaScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Reimplemented from FreqScreen.

◆ Poll()

void MetaArenaScreen::Poll ( float fTime)
overridevirtual

Advance the screen, and change to mPendingScreen once the song preview plays.

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

Reimplemented from UIScreen.

◆ Enter()

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

Enable the arenas that have songs, grey out the locked ones, and focus an arena, then start the entry.

A game of other players disables the Tutorial arena, and offers the first arena when none is unlocked. The focus returns to mArena when the song screen leads back here, and rests on the last unlocked arena otherwise.

Parameters
pPrevScreenThe screen this one replaces.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00191800
Ghidra address:
PAL: 0x00198b18

Reimplemented from FreqScreen.

◆ Title()

const char * MetaArenaScreen::Title ( )
overridevirtual

Report the title of the screen, the localised title with the mode and the difficulty.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x00192550
Ghidra address:
PAL: 0x00199868

Reimplemented from FreqScreen.

◆ UpdateBand()

void MetaArenaScreen::UpdateBand ( UIComponent * pArena,
UIPanel * pPanel )

List the songs of an arena that receives the focus in the s_g_sel_arena panel.

The s_g_sel_arena_band panel labels each song with its artist, or with the reason it is locked. A solo game outside the Tutorial arena also shows the arena score and the score to beat.

Parameters
pArenaThe arena button, or null.
pPanelThe panel of the button.
Ghidra address:
NTSC-U/C: 0x00191ca8
Ghidra address:
PAL: 0x00198fc0

◆ HandleFocusChange()

bool MetaArenaScreen::HandleFocusChange ( UIComponentFocusChangeMsg * pMsg)

List the songs of the arena that receives the focus, and play the wheel sound when the focus moves to another arena than Tutorial.

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

◆ HandleSelect()

bool MetaArenaScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Choose the arena of a button that is not greyed out with the cross button.

The sound output is silenced and the arena recorded in Metagame::mArena. A solo game sets the tutorial for the Tutorial arena and continues to soloarena2solotut, and to soloarena2solosong for any other arena. A game of other players continues to multiarena2multisong, and cannot choose Tutorial.

Parameters
pMsgThe message.
Returns
True while a change is pending, otherwise the result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x00192360
Ghidra address:
PAL: 0x00199678

◆ HandleJoypad()

bool MetaArenaScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Swallow buttons while the screen changes, and go back to the skill menu with the triangle button.

A solo game goes back to soloarena2soloskill, a remix to m_r_mode, and any other game to multiarena2multiskill, and Metagame::mArena is cleared.

Parameters
pMsgThe message of the button.
Returns
True while the screen changes, otherwise false.
Ghidra address:
NTSC-U/C: 0x001925b0
Ghidra address:
PAL: 0x001998c8

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