wavelength 1.0.0
Loading...
Searching...
No Matches
NeedsDialogScreen Class Referenceabstract

A screen whose panels hide while a dialog it opens shows. More...

#include <needsdialogscreen.h>

Inheritance diagram for NeedsDialogScreen:
Collaboration diagram for NeedsDialogScreen:

Public Member Functions

 NeedsDialogScreen (DataArray *pData)
 Construct the screen from its script description.
virtual void SetPanelsShowing (bool bShowing)
 Show or hide every panel of the screen except help and title.
virtual void Proceed ()=0
 Go on from the screen.
Public Member Functions inherited from FreqScreen
 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.

Additional Inherited Members

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.
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

A screen whose panels hide while a dialog it opens shows.

The RTTI records the class as deriving from FreqScreen. The class has no members and no instances of its own. SetupRemixSaveScreen derives from it.

Constructor & Destructor Documentation

◆ NeedsDialogScreen()

NeedsDialogScreen::NeedsDialogScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description.

Inline. The constructors of the derived classes expand it.

Parameters
pDataThe script description.

Member Function Documentation

◆ SetPanelsShowing()

virtual void NeedsDialogScreen::SetPanelsShowing ( bool bShowing)
virtual

Show or hide every panel of the screen except help and title.

Vtable slot 11.

The name is inferred.

Parameters
bShowingWhether the panels show.
Ghidra address:
NTSC-U/C: 0x001ae958
Ghidra address:
PAL: 0x001b7638

◆ Proceed()

virtual void NeedsDialogScreen::Proceed ( )
pure virtual

Go on from the screen.

Vtable slot 12.

The name is inferred.

Implemented in MultiSetupRemixSaveScreen, and SetupRemixSaveScreen.


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