resonance 1.0.1
Loading...
Searching...
No Matches
MetMultiTips2Screen Class Reference

One page of the multiplayer loading tips. More...

#include <metmultitips2screen.h>

Inheritance diagram for MetMultiTips2Screen:
Collaboration diagram for MetMultiTips2Screen:

Public Member Functions

 MetMultiTips2Screen (MetRenderer *pRenderer, int nPriority)
 Construct the screen.
virtual ~MetMultiTips2Screen ()
virtual void ResolveContainerViews ()
 Resolve the container views and fill the page's seven texts from configuration code 0x258.
Public Member Functions inherited from MetMultiTipsBaseScreen
virtual ~MetMultiTipsBaseScreen ()
virtual void EnterAndShow ()
 Show the numbered title, enter, and select the tips help layout.
virtual void BeginExit ()
 Exit the title screen and begin the exit.
virtual void HandleCommand (const MetScreenCommand *pCommand)
 Leave the page.
virtual void PlayHighSound (int nSelector)
virtual void PlayCycleLeftSound (int nSelector)
virtual void PlayCycleRightSound (int nSelector)
virtual void OnEnterFinished ()
 Post the first help prompt.
virtual void OnExitFinished ()
 Push the page the recorded choice leads to.
Public Member Functions inherited from MetScreen
 MetScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &directory, const HxStr &file)
 Construct a screen and start its container load.
virtual ~MetScreen ()
 Unregister from the renderer and release the container.
void DeliverCommand (const MetScreenCommand *pCommand)
 Play the sound one navigation command calls for and then act on the command.
void UpdateAnimationFrame (float flTime)
 Drive the frame of whichever animation is running and run the idle hook when none is.
void UpdateFrame (float flTime)
 Advance one screen by one frame.
virtual void PushNamedScreen (const HxStr &name)
 Bring one named screen onto the renderer's screen stack.
virtual void ActivateNamedPanel (const HxStr &name)
 Make one named screen the renderer's active panel.
virtual void OnPanelActivated ()
 Act on this screen having become the renderer's active panel.
virtual void ExitScreenByName (const HxStr &name)
 Start one named screen's exit animation.
virtual void OnUnusedHook ()
 Do nothing.
virtual void OnKeyboardDismissed ()
 Take control back after the keyboard screen has finished.
virtual void OnDrawPass ()
 Contribute to the renderer's draw pass.
virtual void OnDestroying ()
 Release what the screen acquired, ahead of the rest of destruction.
virtual int PollContainerLoad ()
 Advance this screen's container load and resolve its views once the load finishes.
virtual void OnMsgScreenDismissed (const HxStr &name, int nChoice)
 Act on the choice the user made in a message dialogue.
virtual void OnMsgScreenShown (const HxStr &name)
 Act on a message dialogue becoming visible.
virtual void SetShowing (int nShowing)
 Show or hide the view and every drawable the container loaded.
virtual void BeginContainerLoad (const HxStr &directory, const HxStr &file)
 Intern a container load under this screen's container name and enqueue it.
virtual void PlaySlideSound (int nSelector)
 Play the sound that accompanies sliding between screens.
virtual void PlayLeaveSound (int nSelector)
 Play the sound that accompanies departing a screen.
virtual void PlayErrorSound (int nSelector)
 Play the sound that accompanies a rejected input.
virtual void UpdateIdle (float flTime)
 Advance whatever the screen updates once per frame while it is idle.
virtual void UpdateIdleAnimation (float flTime)
 Advance whatever the screen animates while it is neither entering nor exiting.
virtual void StartRepeatingSound (float flStartTime, float flInterval, Rnd::Button *pButton, int nCycles)
 Start alternating one button between its states 2 and 1.
virtual void UpdateRepeatingSound (float flTime)
 Advance the alternation that StartRepeatingSound() started.
virtual void OnRepeatingSoundFinished (Rnd::Button *pButton)
 Act on the alternation that StartRepeatingSound() started having finished.
virtual void StartEnterAnimation (float flTime)
 Rewind the enter animation and record the time it starts at.
virtual void UpdateEnterAnimation (float flTime)
 Drive the enter animation and finish it once it passes its end.
virtual void StartExitAnimation (float flTime)
 Record the time the exit animation starts at.
virtual void UpdateExitAnimation (float flTime)
 Drive the exit animation and hide the screen once it passes its end.
virtual void Draw ()
 Draw the view.
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the tagged heap under the tag "MsgSink".
void operator delete (void *pBlock)
 Release a sink to the tagged heap.
virtual ~MsgSink ()
virtual void Dispatch (Message *pMsg)
 Accept a message.

Static Public Member Functions

static MetMultiTips2Screen * New (MetRenderer *pRenderer, int nPriority)
 Build the screen on the heap.
Static Public Member Functions inherited from MetScreen
static std::map< HxStr, MetContainerLoad * > & ContainerLoaderMap ()
 Shared table of container loads, interned under the container name.
static std::map< HxStr, MetScreenEntry > & ScreenRegistry ()
 Shared table of live screens, interned under the screen registry key.
static MetScreen * FindScreenByName (const HxStr &name)
 Resolve one screen by its registry key.
static MetScreen * FindEndScreen (MetRenderer *pRenderer, const HxStr &name)
 Resolve one end-of-game screen by its registry key, failing fatally when it is absent.
static void CreateMainMenuScreens (MetRenderer *pRenderer)
 Create the main-menu screens.
static void DestroyAllScreens ()
 Delete every registered screen and release every container loader.
static void CreateStartupScreens (MetRenderer *pRenderer)
 Create the four screens the front end needs before its containers have loaded.
static void CreateFrontEndScreens (MetRenderer *pRenderer)
 Create every remaining front-end screen, once.
static void DestroyCategory2Screens ()
 Delete and unregister every screen in category 2.
static void DestroyCategory1Screens ()
 Delete and unregister every screen in category 1.
static void DestroyNonDefaultScreens ()
 Delete and unregister every screen outside category 0, then rewind the rndMetLocAndNet zone.
static void PollContainerLoads ()
 Poll every container load that has not finished, and hide the drawables of each that does.

Additional Inherited Members

Public Attributes inherited from MetScreen
Rnd::View * mView
 The container's root view.
int mEnterPending
 Set when the screen was pushed before its container load finished.
int mActivatePending
 Set when the screen was activated as a panel before its container load finished.
float mRepeatScale
 Scale on the input auto-repeat interval.
Protected Types inherited from MetMultiTipsBaseScreen
enum  Exit { kExitPrevious = 0 , kExitNext = 1 , kExitQuit = 2 }
 The exit a command recorded in MetScreen::mExitChoice. More...
Protected Member Functions inherited from MetMultiTipsBaseScreen
 MetMultiTipsBaseScreen (MetRenderer *pRenderer, int nPriority, const HxStr &name, const HxStr &file, int nPage, const HxStr &previous, const HxStr &next)
 Construct a tip page.
void ReturnToPlayerCount ()
 Return to the player-count screen.
Protected Member Functions inherited from MetScreen
virtual void DispatchPriv (Message *pMsg)
 Act on a message.
void ResolveAnimationViews ()
 Resolves the two animation views from the screen name and records the enter animation's end frame.
Protected Attributes inherited from MetScreen
float mAnimEndFrame
float mEnterStartTime
MetRenderer * mRenderer
int mExitChoice
int mAcceptsCommands
Rnd::View * mEnterAnim
std::vector< HxStr > mHelpKeys
int mViewsUnresolved
int mPlaysCommandSounds
int mShowsLoadedDrawables

Detailed Description

One page of the multiplayer loading tips.

Its RTTI descriptor is at 0x008eedf8. It has MetMultiTipsBaseScreen as its one public non-virtual base at offset 0. The class declares no data member. The 39-entry vtable at 0x00801390 is the same length as the MetMultiTipsBaseScreen table, and the class declares no new virtual.

The constructor at 0x00307d68 takes only the renderer and the load priority. It runs the MetMultiTipsBaseScreen constructor at 0x00306cd8 with tp2 for the screen name, multi_tip_02 for the container, and two screen registry keys, MetMultiTips1Screen for the previous page and MetMultiTips3Screen for the next. The five tip pages form a ring through those two keys, and both ends of the ring lead to MetLocNumPlayersScreen.

The destructor is at 0x0030da98.

Apart from the type function and the destructor, the slots that differ from the MetMultiTipsBaseScreen table are 38 0x00307f38.

Constructor & Destructor Documentation

◆ MetMultiTips2Screen()

MetMultiTips2Screen::MetMultiTips2Screen ( MetRenderer * pRenderer,
int nPriority )

Construct the screen.

Parameters
pRendererThe front-end renderer this screen registers on.
nPriorityThe load priority.
Ghidra address:
NTSC-U/C: 0x00307d68
Ghidra address:
PAL: 0x0032cd48

◆ ~MetMultiTips2Screen()

virtual MetMultiTips2Screen::~MetMultiTips2Screen ( )
virtual
Ghidra address:
NTSC-U/C: 0x0030da98
Ghidra address:
PAL: 0x00333638

Member Function Documentation

◆ New()

MetMultiTips2Screen * MetMultiTips2Screen::New ( MetRenderer * pRenderer,
int nPriority )
static

Build the screen on the heap.

The routine at 0x00385180 that creates every front-end screen is the caller.

Parameters
pRendererThe front-end renderer the screen registers on.
nPriorityThe load priority.
Returns
The new screen.
Ghidra address:
NTSC-U/C: 0x0030db18
Ghidra address:
PAL: 0x003336e0

◆ ResolveContainerViews()

virtual void MetMultiTips2Screen::ResolveContainerViews ( )
virtual

Resolve the container views and fill the page's seven texts from configuration code 0x258.

Slot 38. The texts are not tested for null.

Ghidra address:
NTSC-U/C: 0x00307f38
Ghidra address:
PAL: 0x0032cf90

Reimplemented from MetScreen.


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