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

The custom screen of the Freq maker, with a button for each part the player can change. More...

#include <freqmakercustomscreen.h>

Inheritance diagram for FreqMakerCustomScreen:
Collaboration diagram for FreqMakerCustomScreen:

Public Member Functions

 FreqMakerCustomScreen (DataArray *pData)
 Construct the screen from its script description.
 ~FreqMakerCustomScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route controller buttons and buttons about to be chosen, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Copy the Freq unless a copy is pending, and start the entry.
const char * Title () override
 Report the localised title, f_maker_c_TITLE.
void Undo () override
 Restore the Freq from the copy the entry made.
void UpdateDone ()
 Disable done while a needed part of the Freq is missing, and enable it otherwise.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Return to f_maker on the triangle button, through f_maker_lose_custom_changes when the Freq changed.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Accept the changes on done, remove the parts on clear, and note a change on the other buttons chosen with the cross button.
Public Member Functions inherited from FreqMakerUndoScreen
 FreqMakerUndoScreen (DataArray *pData)
 Construct the screen from its script description.
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 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 custom screen of the Freq maker, with a button for each part the player can change.

The RTTI records the class as deriving from FreqMakerUndoScreen. The object is 0xc0 bytes and its vtable is at 0x003cfe30. The metagame registers the class for the screen type f_maker_custom_screen, and the front-end description's f_maker_custom screen is one. Its f_maker_c panel leads from each part to f_maker_part, from emblems to f_maker_emblem, and from done to f_maker. The screen copies the Freq when it first enters, to restore it when the player abandons the changes.

Constructor & Destructor Documentation

◆ FreqMakerCustomScreen()

FreqMakerCustomScreen::FreqMakerCustomScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x00360ed8
Ghidra address:
PAL: 0x003cf3f0

◆ ~FreqMakerCustomScreen()

FreqMakerCustomScreen::~FreqMakerCustomScreen ( )
override

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00360db8
Ghidra address:
PAL: 0x003cf2d0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type f_maker_custom_screen.

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

◆ DispatchPriv()

bool FreqMakerCustomScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route controller buttons and buttons about to be chosen, and pass on every other message.

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

Implements MsgSink.

◆ Enter()

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

Copy the Freq unless a copy is pending, and start the entry.

The gear and emblem buttons are disabled when the player has unlocked no choice for them, and done is disabled while a needed part is missing. Entering from f_maker forgets earlier changes.

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

Reimplemented from UIScreen.

◆ Title()

const char * FreqMakerCustomScreen::Title ( )
overridevirtual

Report the localised title, f_maker_c_TITLE.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x001a0710
Ghidra address:
PAL: 0x001a83f0

Reimplemented from FreqScreen.

◆ Undo()

void FreqMakerCustomScreen::Undo ( )
overridevirtual

Restore the Freq from the copy the entry made.

Ghidra address:
NTSC-U/C: 0x001a07e0
Ghidra address:
PAL: 0x001a84c0

Implements FreqMakerUndoScreen.

◆ UpdateDone()

void FreqMakerCustomScreen::UpdateDone ( )

Disable done while a needed part of the Freq is missing, and enable it otherwise.

Ghidra address:
NTSC-U/C: 0x001a0740
Ghidra address:
PAL: 0x001a8420

◆ HandleJoypad()

bool FreqMakerCustomScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Return to f_maker on the triangle button, through f_maker_lose_custom_changes when the Freq changed.

Parameters
pMsgThe message.
Returns
True while the screen moves, otherwise the result of FreqScreen::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x001a08b0
Ghidra address:
PAL: 0x001a8590

◆ HandleSelectStart()

bool FreqMakerCustomScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Accept the changes on done, remove the parts on clear, and note a change on the other buttons chosen with the cross button.

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

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