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

The dialog that prompts the player to plug a controller back in. More...

#include <nocontrollerscreen.h>

Inheritance diagram for NoControllerScreen:
Collaboration diagram for NoControllerScreen:

Public Member Functions

 ~NoControllerScreen () override=default
 Destroy the object.
 NoControllerScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a controller button, and pass every other message to FreqScreen.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry and name the controller port in the dialog text.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Close the dialog when the cross button of mPad goes down.
void SetPad (int nPad)
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 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 dialog that prompts the player to plug a controller back in.

The cross button of that controller closes it.

The RTTI records the class as deriving from FreqScreen. The object is 0x8c bytes and its vtable is at 0x003cef68. The metagame registers the class for the screen type no_controller_screen. The description's in_game entry tells whether the dialog interrupts a song or the front end. Closing it resumes the song, or returns to mReturnScreen.

Constructor & Destructor Documentation

◆ ~NoControllerScreen()

NoControllerScreen::~NoControllerScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035d2b8
Ghidra address:
PAL: 0x003cb390

◆ NoControllerScreen()

NoControllerScreen::NoControllerScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018ca10
Ghidra address:
PAL: 0x00193548

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the screen type no_controller_screen.

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

◆ DispatchPriv()

bool NoControllerScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a controller button, and pass every other message to FreqScreen.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Start the entry and name the controller port in the dialog text.

Parameters
pPrevScreenThe screen this one replaces, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x0018ca98
Ghidra address:
PAL: 0x001935d0

Reimplemented from FreqScreen.

◆ HandleJoypad()

bool NoControllerScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Close the dialog when the cross button of mPad goes down.

Parameters
pMsgThe message of the button.
Returns
True while the screen moves in or out, otherwise the result of FreqScreen::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x0018cbc0
Ghidra address:
PAL: 0x00193718

◆ SetPad()

void NoControllerScreen::SetPad ( int nPad)
inline
Parameters
nPadThe controller to plug back in.

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