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

An intro screen the cross button cuts short. More...

#include <marketingscreen.h>

Inheritance diagram for MarketingScreen:
Collaboration diagram for MarketingScreen:

Public Member Functions

 ~MarketingScreen () override=default
 Destroy the object.
 MarketingScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route a controller button, and pass every other message to IntroScreen.
bool HandleJoypad (JoypadInputMsg *pMsg)
 End a running hold at the next poll when the cross button goes down.
Public Member Functions inherited from IntroScreen
 ~IntroScreen () override=default
 Destroy the object.
 IntroScreen (DataArray *pData)
 Construct the screen from its script description.
void Poll (float fTime) override
 Advance the screen, and move to the next screen once the hold has run out.
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 Draw ()
 Draw the panels.
virtual void Exit (UIScreen *pNextScreen, float fTime)
 Start the exit to another screen.
virtual void Enter (UIScreen *pPrevScreen, float fTime)
 Become the current screen and start the entry animations of the panels.
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 IntroScreen
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

Protected Member Functions inherited from IntroScreen
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start the hold.
Protected Attributes inherited from IntroScreen
float mEndTime
float mHoldMs
const char * mNextScreen
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

An intro screen the cross button cuts short.

The RTTI records the class as deriving from IntroScreen. The object is 0x48 bytes and its vtable is at 0x003cf018. The metagame registers the class for the screen type mktg_screen.

Constructor & Destructor Documentation

◆ ~MarketingScreen()

MarketingScreen::~MarketingScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035d0e8
Ghidra address:
PAL: 0x003cb1c0

◆ MarketingScreen()

MarketingScreen::MarketingScreen ( DataArray * pData)
inlineexplicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x0018c388
Ghidra address:
PAL: 0x00192ec0

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the screen type mktg_screen.

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

◆ DispatchPriv()

bool MarketingScreen::DispatchPriv ( Message * pMsg)
overridevirtual

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

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

Reimplemented from IntroScreen.

◆ HandleJoypad()

bool MarketingScreen::HandleJoypad ( JoypadInputMsg * pMsg)

End a running hold at the next poll when the cross button goes down.

Parameters
pMsgThe message of the button.
Returns
True while the screen moves in or out, otherwise false.
Ghidra address:
NTSC-U/C: 0x0018c3c0
Ghidra address:
PAL: 0x00192ef8

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