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

A launchpad screen of an online session, with the players, the game, and the chat of the session. More...

#include <netlpadscreen.h>

Inheritance diagram for NetLpadScreen:
Collaboration diagram for NetLpadScreen:

Public Member Functions

 ~NetLpadScreen () override=default
 Destroy the object.
 NetLpadScreen (DataArray *pData)
 Construct the screen from its script description.
bool DispatchPriv (Message *pMsg) override
 Route the messages of the screen, and pass on every other message.
void Poll (float fTime) override
 Advance the screen, and show the players of the session when they change.
void Exit (UIScreen *pNextScreen, float fTime) override
 Start the exit, moving the focus to the command panel unless the next screen is another launchpad screen.
void Enter (UIScreen *pPrevScreen, float fTime) override
 Start the entry.
void UpdateGameParams (const NetGameParams *pParams)
 Take the settings of the game the host published, and show them while this screen is the current one.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Give the circle button to the chat after moving the focus to the command panel, and pass on every button.
bool HandleKeyboardKey (KeyboardKeyMsg *pMsg)
 Give a key of the USB keyboard to the chat.
bool HandleTextEntryComplete (UITextEntryCompleteMsg *pMsg)
 Give typed text to the chat.
bool HandleFocusChange (UIComponentFocusChangeMsg *pMsg)
 Show the screen of the command that receives the focus in the command panel.
bool HandleSelectStart (UIComponentSelectStartMsg *pMsg)
 Move the focus to the game panel when right is pressed on the player command.
bool HandleSelect (UIComponentSelectMsg *pMsg)
 Run the command chosen with the cross button.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Report to the session that the screen shows, or show the lost session dialog.
const std::list< NetLaunchpadPlayer > & GetPlayers () const
std::list< NetLaunchpadPlayer > & GetPlayers ()
const char * GetButtonPanel () const
Public Member Functions inherited from FreqScreen
 FreqScreen (DataArray *pData)
 Construct a screen from its script description.
 ~FreqScreen () override
 Destroy the screen.
void Draw () override
 Draw what goes under each panel, then the panels.
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 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

A launchpad screen of an online session, with the players, the game, and the chat of the session.

The RTTI records the class as deriving from FreqScreen. The object is 0x84 bytes and its vtable is at 0x003cd988. The metagame registers the class for the screen type lpad_screen, and the fn_h_lpad and fn_g_lpad screens of the host and the guests are ones. The description provides dataPanel, the panel of the game, and buttonPanel, the panel of the commands. The chat panel is fn_h_lpad_c. Moving between two launchpad screens skips the animations of the panels.

Constructor & Destructor Documentation

◆ ~NetLpadScreen()

NetLpadScreen::~NetLpadScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035bcc0
Ghidra address:
PAL: 0x003c9818

◆ NetLpadScreen()

NetLpadScreen::NetLpadScreen ( DataArray * pData)
explicit

Construct the screen from its script description.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x001873a8
Ghidra address:
PAL: 0x0018b5e8

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the screen type lpad_screen.

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

◆ DispatchPriv()

bool NetLpadScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the messages of the screen, and pass on every other message.

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

Reimplemented from FreqScreen.

◆ Poll()

void NetLpadScreen::Poll ( float fTime)
overridevirtual

Advance the screen, and show the players of the session when they change.

Without a session the lost session dialog shows.

Parameters
fTimeThe front-end time.
Ghidra address:
NTSC-U/C: 0x00187708
Ghidra address:
PAL: 0x0018b948

Reimplemented from UIScreen.

◆ Exit()

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

Start the exit, moving the focus to the command panel unless the next screen is another launchpad screen.

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

Reimplemented from FreqScreen.

◆ Enter()

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

Start the entry.

Coming back from the remix editor, the host tells the guests and the session that the editing is done.

Parameters
pPrevScreenThe screen this one replaces, or null.
fTimeThe front-end time in milliseconds.
Ghidra address:
NTSC-U/C: 0x00187468
Ghidra address:
PAL: 0x0018b6a8

Reimplemented from FreqScreen.

◆ UpdateGameParams()

void NetLpadScreen::UpdateGameParams ( const NetGameParams * pParams)

Take the settings of the game the host published, and show them while this screen is the current one.

Parameters
pParamsThe settings.
Ghidra address:
NTSC-U/C: 0x00187640
Ghidra address:
PAL: 0x0018b880

◆ HandleJoypad()

bool NetLpadScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Give the circle button to the chat after moving the focus to the command panel, and pass on every button.

Parameters
pMsgThe message of the button.
Returns
True while the screen moves in or out, otherwise the result of FreqScreen::HandleJoypad().
Ghidra address:
NTSC-U/C: 0x00187a70
Ghidra address:
PAL: 0x0018bcb0

◆ HandleKeyboardKey()

bool NetLpadScreen::HandleKeyboardKey ( KeyboardKeyMsg * pMsg)

Give a key of the USB keyboard to the chat.

Parameters
pMsgThe message.
Returns
Whether the chat handled the key.
Ghidra address:
NTSC-U/C: 0x00187b68
Ghidra address:
PAL: 0x0018bda8

◆ HandleTextEntryComplete()

bool NetLpadScreen::HandleTextEntryComplete ( UITextEntryCompleteMsg * pMsg)

Give typed text to the chat.

Parameters
pMsgThe message.
Returns
The result of ChatPanel::HandleTextEntryComplete().
Ghidra address:
NTSC-U/C: 0x00187bc0
Ghidra address:
PAL: 0x0018be00

◆ HandleFocusChange()

bool NetLpadScreen::HandleFocusChange ( UIComponentFocusChangeMsg * pMsg)

Show the screen of the command that receives the focus in the command panel.

The player command has the screen <buttonPanel>_play, and every other command the screen <buttonPanel>.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x00187c08
Ghidra address:
PAL: 0x0018be48

◆ HandleSelectStart()

bool NetLpadScreen::HandleSelectStart ( UIComponentSelectStartMsg * pMsg)

Move the focus to the game panel when right is pressed on the player command.

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

◆ HandleSelect()

bool NetLpadScreen::HandleSelect ( UIComponentSelectMsg * pMsg)

Run the command chosen with the cross button.

Parameters
pMsgThe message.
Returns
The result of UIScreen::HandleSelect().
Ghidra address:
NTSC-U/C: 0x00187d78
Ghidra address:
PAL: 0x0018bfb8

◆ HandleTransitionComplete()

bool NetLpadScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Report to the session that the screen shows, or show the lost session dialog.

Parameters
pMsgThe message.
Returns
False.
Ghidra address:
NTSC-U/C: 0x00187f58
Ghidra address:
PAL: 0x0018c198

◆ GetPlayers() [1/2]

const std::list< NetLaunchpadPlayer > & NetLpadScreen::GetPlayers ( ) const
inline
Returns
The players shown.

◆ GetPlayers() [2/2]

std::list< NetLaunchpadPlayer > & NetLpadScreen::GetPlayers ( )
inline
Returns
The players shown.

◆ GetButtonPanel()

const char * NetLpadScreen::GetButtonPanel ( ) const
inline
Returns
The buttonPanel entry of the description.

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