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

Front-end screen of the metagame, which places the menu projector and plays the menu sounds. More...

#include <freqscreen.h>

Inheritance diagram for FreqScreen:
Collaboration diagram for FreqScreen:

Public Member Functions

 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Play the sound of a chosen component, follow a shortcut, and keep unused controllers out.
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.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Play the entry sound, show or hide the projector, and start the entry.
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 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 UIScreen
static UIScreen * New (DataArray *pData)
 Create a screen from its script description.

Public Attributes

Vector3 mGizmoOrig
Quat mGizmoRot

Additional Inherited Members

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

Front-end screen of the metagame, which places the menu projector and plays the menu sounds.

The RTTI records the class as deriving from UIScreen. The object is 0x70 bytes and its vtable is at 0x003cfcb0. The metagame registers the class for the screen type freq_screen, and nearly every screen class of the front end derives from it. Besides the entries UIScreen reads, the description provides these:

  • gizmoOrig, the position of the projector while the screen shows;
  • gizmoRot, its orientation as three Euler angles;
  • no_gizmo, whether the projector hides;
  • no_projector_sfx, whether entering the screen plays no projector sound;
  • needs_transition_sfx, whether the screen plays the transition sound instead.

Only controllers the players use may press buttons. A screen listed in the shortcuts section of the metagame configuration chooses the component it names as soon as it has entered.

Constructor & Destructor Documentation

◆ FreqScreen()

FreqScreen::FreqScreen ( DataArray * pData)
explicit

Construct a screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0019e3b0
Ghidra address:
PAL: 0x001a60c8

◆ ~FreqScreen()

FreqScreen::~FreqScreen ( )
override

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x0019e490
Ghidra address:
PAL: 0x001a61a8

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type freq_screen.

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

◆ DispatchPriv()

bool FreqScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Play the sound of a chosen component, follow a shortcut, and keep unused controllers out.

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

Implements MsgSink.

Reimplemented in GameOptionsScreen, JukeboxScreen, ListRemixesScreen, LoadFreqScreen, LoadNetConfigsScreen, LoadRemixScreen, MainOptionsScreen, MCCheckScreen, MetaArenaScreen, MetaMainScreen, MetaSkillScreen, MetaSongScreen, MetaStartScreen, ModeScreen, MultiEndGameScreen, MultiFreqSelectScreen, MultiLoadFreqScreen, MultiSetupRemixSaveScreen, NetChangePassword, NetChangePasswordScreen, NetChooseIConfigScreen, NetCreateAccount, NetCreateConfigScreen, NetCreateUserScreen, NetDoDownloadScreen, NetDoPlayerSearchScreen, NetDoUploadScreen, NetEndGameScreen, NetEULAScreen, NetGetDownloadsScreen, NetHostAttemptScreen, NetHostingScreen, NetInetConnect, NetInetDisconnect, NetJoinLPadScreen, NetLaunchpadQuitScreen, NetLaunchScreen, NetLobbyConnect, NetLobbyDisconnect, NetLoginScreen, NetLpadScreen, NetMainScreen, NetNewChatroomScreen, NetParamsScreen, NetPasswordScreen, NetRankingScreen, NetReadOnlyWarnScreen, NetSearchScreen, NetServerLogin, NetServerSelScreen, NetSortedScreen, NetSwitchLobbyScreen, NoControllerScreen, NumPlayersScreen, PartUnlockScreen, PauseScreen, PlayerSearchResultsScreen, PowerupScreen, PreLaunchScreen, ReadOnlyCheckScreen, ReadOnlySaveScreen, RedbookPlaybackScreen, RemixControllerScreen, RemixCopyDelScreen, RemixCreateModeScreen, RemixDiscardScreen, RemixOrFreqScreen, RemixSelectScreen, RemixSongScreen, RemixTypeScreen, SaveEditedFreqScreen, SaveErrorScreen, SaveFreqScreen, SaveRemixScreen, SaveSettingsScreen, SelLoadedFreqScreen, SelRemixDownloadScreen, SelRemixUploadScreen, SetupNameScreen, SetupRemixSaveScreen, ShareRemixScreen, SoloEndGameScreen, TipsScreen, UnlockScreen, UploadNoteScreen, and XProceedScreen.

◆ Draw()

void FreqScreen::Draw ( )
overridevirtual

Draw what goes under each panel, then the panels.

Ghidra address:
NTSC-U/C: 0x0019e4e8
Ghidra address:
PAL: 0x001a6200

Reimplemented from UIScreen.

◆ Exit()

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

Move the projector to the next screen's place and start the exit.

The projector moves over time in the front end and jumps there at once otherwise, or when this screen hides it.

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

Reimplemented from UIScreen.

Reimplemented in JukeboxScreen, MainOptionsScreen, MCCheckScreen, MetaMainScreen, MetaSongScreen, MetaStartScreen, NetLpadScreen, NetMainScreen, NetParamsScreen, PartUnlockScreen, and SongDecryptScreen.

◆ Enter()

◆ Title()

◆ PlayButtonSound()

virtual void FreqScreen::PlayButtonSound ( int nButton)
virtual

Play the menu sound of a controller button.

The cross button and the directional buttons have sounds. Other buttons play nothing.

Parameters
nButtonOne of JoypadButton.
Ghidra address:
NTSC-U/C: 0x0019e920
Ghidra address:
PAL: 0x001a6638

Reimplemented in KeyboardScreen.

◆ HandleSelectStart()

bool FreqScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Play the sound of the button that chooses a component.

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

◆ HandleTransitionComplete()

bool FreqScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Choose the component the shortcuts section of the metagame configuration lists for the screen.

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

◆ HandleJoypad()

bool FreqScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Pass on a controller button of a controller the players use, and swallow any other.

Parameters
pMsgThe message of the button.
Returns
The result of UIScreen::HandleJoypad(), or true for an unused controller.
Ghidra address:
NTSC-U/C: 0x0019eaa8
Ghidra address:
PAL: 0x001a67c0

Member Data Documentation

◆ mGizmoOrig

Vector3 FreqScreen::mGizmoOrig

The position of the projector, gizmoOrig.

◆ mGizmoRot

Quat FreqScreen::mGizmoRot

The orientation of the projector, from gizmoRot.


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