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

Screen that offers to abandon the changes of a Freq maker screen. More...

#include <freqmakererrorscreen.h>

Inheritance diagram for FreqMakerErrorScreen:
Collaboration diagram for FreqMakerErrorScreen:

Public Member Functions

 ~FreqMakerErrorScreen () override=default
 Destroy the object.
 FreqMakerErrorScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a button about to be chosen, and pass on every other message.
void SetScreens (const char *pszContinue, const char *pszCancel)
 Find the screens the buttons lead to.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Abandon the changes and continue on continue, or return on cancel.
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.

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

Screen that offers to abandon the changes of a Freq maker screen.

The RTTI records the class as deriving from FreqScreen. The object is 0x80 bytes and its vtable is at 0x003cfd10. The metagame registers the class for the screen type f_maker_error_screen, and the front-end description's f_maker_lose_main_changes and f_maker_lose_custom_changes screens are two. The screen that opens it sets the two screens with SetScreens(). The destructor at 0x00361120 is compiler-generated and has no declaration here.

Constructor & Destructor Documentation

◆ ~FreqMakerErrorScreen()

FreqMakerErrorScreen::~FreqMakerErrorScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00361120
Ghidra address:
PAL: 0x003cf638

◆ FreqMakerErrorScreen()

FreqMakerErrorScreen::FreqMakerErrorScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x003611f8
Ghidra address:
PAL: 0x003cf710

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type f_maker_error_screen.

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

◆ DispatchPriv()

bool FreqMakerErrorScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route a button about to be chosen, and pass on every other message.

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

Implements MsgSink.

◆ SetScreens()

void FreqMakerErrorScreen::SetScreens ( const char * pszContinue,
const char * pszCancel )

Find the screens the buttons lead to.

Parameters
pszContinueThe screen continue leads to.
pszCancelThe Freq maker screen cancel returns to. Its changes are abandoned when the player continues.
Ghidra address:
NTSC-U/C: 0x001a2418
Ghidra address:
PAL: 0x001aa0f8

◆ HandleSelectStart()

bool FreqMakerErrorScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Abandon the changes and continue on continue, or return on cancel.

Parameters
pMsgThe message.
Returns
The result of FreqScreen::HandleSelectStart().
Ghidra address:
NTSC-U/C: 0x001a2478
Ghidra address:
PAL: 0x001aa158

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