Front-end screen of the metagame, which places the menu projector and plays the menu sounds.
More...
|
| | 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.
|
| | 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 |
| 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.
|
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.
| bool FreqScreen::DispatchPriv |
( |
Message * | pMsg | ) |
|
|
overridevirtual |
Play the sound of a chosen component, follow a shortcut, and keep unused controllers out.
- Parameters
-
- 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.
| void FreqScreen::Enter |
( |
UIScreen * | pPrevScreen, |
|
|
float | fTime ) |
|
overridevirtual |
Play the entry sound, show or hide the projector, and start the entry.
- Parameters
-
| pPrevScreen | The screen this one replaces, or null. |
| fTime | The front-end time in milliseconds. |
- Ghidra address:
- NTSC-U/C: 0x0019e698
- Ghidra address:
- PAL: 0x001a63b0
Reimplemented from UIScreen.
Reimplemented in GameOptionsScreen, JukeboxScreen, LaunchScreen, MainOptionsScreen, MetaArenaScreen, MetaMainScreen, MetaSkillScreen, MetaSongScreen, MetaStartScreen, ModeScreen, MsgErrorScreen, MultiEndGameScreen, MultiFreqSelectScreen, MultiLoadFreqScreen, MultiSetupRemixSaveScreen, NameErrorScreen, NetChangePasswordScreen, NetChooseIConfigScreen, NetCreateUserScreen, NetEULAScreen, NetHostingScreen, NetLoginScreen, NetLpadScreen, NetMainScreen, NetParamsScreen, NetPasswordScreen, NetRankingScreen, NetSearchScreen, NetServerSelScreen, NetSortedScreen, NetWelcomeScreen, NoControllerScreen, NumPlayersScreen, PartUnlockDoneScreen, PartUnlockScreen, PauseScreen, PlayerSearchResultsScreen, PowerupScreen, PupTipsScreen, RedbookPlaybackScreen, RemixOrFreqScreen, RemixSelectScreen, RemixSongScreen, RemixTypeScreen, SaveFreqScreen, SelLoadedFreqScreen, SelRemixDownloadScreen, SetupNameScreen, SetupNewChatroomScreen, SetupRemixSaveScreen, SoloEndGameScreen, SongDecryptScreen, SpaceErrorScreen, TipsScreen, TransitionErrorScreen, and UploadNoteScreen.