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

The emblem screen of the Freq maker, for choosing the emblem on the torso. More...

#include <freqmakeremblemscreen.h>

Inheritance diagram for FreqMakerEmblemScreen:
Collaboration diagram for FreqMakerEmblemScreen:

Public Member Functions

 FreqMakerEmblemScreen (DataArray *pData)
 Construct the screen from its script description.
 ~FreqMakerEmblemScreen () override
 Destroy the screen.
bool DispatchPriv (Message *pMsg) override
 Route buttons about to be chosen and controller buttons, and pass on every other message.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry, list the unlocked emblems, and show the current one.
void Exit (UIScreen *pNextScreen, float fTime) override
 Start the exit and turn the camera back to the whole Freq.
const char * Title () override
 Report the localised title, f_maker_c_TITLE.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Step through the emblems on part, and move the focus to done on the cross button.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Restore the emblem and return to f_maker_custom on the triangle button.
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 emblem screen of the Freq maker, for choosing the emblem on the torso.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003cfd70. The metagame registers the class for the screen type f_maker_emblem_screen, and the front-end description's f_maker_emblem screen is one. Its f_maker_e panel steps through the unlocked emblems with part.

Constructor & Destructor Documentation

◆ FreqMakerEmblemScreen()

FreqMakerEmblemScreen::FreqMakerEmblemScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001a20b8
Ghidra address:
PAL: 0x001a9d98

◆ ~FreqMakerEmblemScreen()

FreqMakerEmblemScreen::~FreqMakerEmblemScreen ( )
override

Destroy the screen.

Ghidra address:
NTSC-U/C: 0x00361020
Ghidra address:
PAL: 0x003cf538

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the entry type f_maker_emblem_screen.

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

◆ DispatchPriv()

bool FreqMakerEmblemScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Implements MsgSink.

◆ Enter()

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

Start the entry, list the unlocked emblems, and show the current one.

A current emblem that is not unlocked is added to the end of the list.

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

Reimplemented from UIScreen.

◆ Exit()

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

Start the exit and turn the camera back to the whole Freq.

Parameters
pNextScreenThe screen that replaces this one, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x001a2060
Ghidra address:
PAL: 0x001a9d40

Reimplemented from UIScreen.

◆ Title()

const char * FreqMakerEmblemScreen::Title ( )
overridevirtual

Report the localised title, f_maker_c_TITLE.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x001a2088
Ghidra address:
PAL: 0x001a9d68

Reimplemented from FreqScreen.

◆ HandleSelectStart()

bool FreqMakerEmblemScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Step through the emblems on part, and move the focus to done on the cross button.

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

◆ HandleJoypad()

bool FreqMakerEmblemScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Restore the emblem and return to f_maker_custom on the triangle button.

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

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