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

The options menu of the front end. More...

#include <mainoptionsscreen.h>

Inheritance diagram for MainOptionsScreen:
Collaboration diagram for MainOptionsScreen:

Public Member Functions

 ~MainOptionsScreen () override=default
 Destroy the object.
 MainOptionsScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a controller button, and pass on every other message.
void Exit (UIScreen *pNextScreen, float fTime) override
 Exit, and move the projector aside when the credits are next.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Enter, and move the projector back from the credits.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Go back to the main menu on Triangle, unless the screen is between screens.
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 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 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 options menu of the front end.

The RTTI records the class as deriving from FreqScreen. The object is 0x70 bytes and its vtable is at 0x003cc3d0. Triangle leads back to the main menu, or to the online main menu in an online game. The projector moves aside while the credits show.

Constructor & Destructor Documentation

◆ ~MainOptionsScreen()

MainOptionsScreen::~MainOptionsScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003567c0
Ghidra address:
PAL: 0x003c3a20

◆ MainOptionsScreen()

MainOptionsScreen::MainOptionsScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x00356818
Ghidra address:
PAL: 0x003c3a78

Member Function Documentation

◆ New()

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

Create a screen from its script description.

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

◆ DispatchPriv()

bool MainOptionsScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Reimplemented from FreqScreen.

◆ Exit()

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

Exit, and move the projector aside when the credits are next.

Parameters
pNextScreenThe screen that replaces this one.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x0016b6b8
Ghidra address:
PAL: 0x0016e840

Reimplemented from FreqScreen.

◆ Enter()

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

Enter, and move the projector back from the credits.

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

Reimplemented from FreqScreen.

◆ HandleJoypad()

bool MainOptionsScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Go back to the main menu on Triangle, unless the screen is between screens.

Parameters
pMsgThe message.
Returns
The result of FreqScreen::HandleJoypad(), or true between screens.
Ghidra address:
NTSC-U/C: 0x0016b740
Ghidra address:
PAL: 0x0016e8c8

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