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

The dialog shown while this console tries to join an online session. More...

#include <netjoinlpadscreen.h>

Inheritance diagram for NetJoinLPadScreen:
Collaboration diagram for NetJoinLPadScreen:

Public Member Functions

 ~NetJoinLPadScreen () override=default
 Destroy the object.
 NetJoinLPadScreen (DataArray *pData)
 Construct the screen from its script description, with no session chosen.
bool DispatchPriv (Message *pMsg) override
 Route the messages of the session, the end of the entry, and the controller buttons, and pass on every other message.
const char * Title () override
 Report the empty title of the screen.
void SetLaunchpad (int nLaunchpadId, int nLaunchpadWorld)
 Choose the session to join.
bool HandleTransitionComplete (UITransitionCompleteMsg *pMsg)
 Start joining once the screen has entered, recording the screen it entered from.
bool HandleSuccess (JoinLaunchpadSuccessMsg *pMsg)
 Take the settings of the game, clear the chat of the launchpad, and go to it, unless the player cancelled.
bool HandleAborted (LaunchpadAbortedMsg *pMsg)
 Go back after a cancel, or show the error of the failure.
bool HandleJoypad (JoypadInputMsg *pMsg)
 Cancel the attempt when the triangle button goes down.
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.
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 void ShowLaunchpadLost ()
 Show the lpad_error dialog with the lost session message, unless an error dialog already shows or is about to.
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 dialog shown while this console tries to join an online session.

The RTTI records the class as deriving from FreqScreen. The object is 0x90 bytes and its vtable is at 0x003cda48. The metagame registers the class for the screen type net_join_lpad_screen. The triangle button cancels the attempt, and a failure shows the lpad_error dialog before going back to the screen the attempt started from.

Constructor & Destructor Documentation

◆ ~NetJoinLPadScreen()

NetJoinLPadScreen::~NetJoinLPadScreen ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0035bae0
Ghidra address:
PAL: 0x003c9638

◆ NetJoinLPadScreen()

NetJoinLPadScreen::NetJoinLPadScreen ( DataArray * pData)
explicit

Construct the screen from its script description, with no session chosen.

Parameters
pDataThe script description.
Ghidra address:
NTSC-U/C: 0x00186c50
Ghidra address:
PAL: 0x0018ae90

Member Function Documentation

◆ New()

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

Create a screen from its script description.

The metagame registers the routine for the screen type net_join_lpad_screen.

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

◆ ShowLaunchpadLost()

void NetJoinLPadScreen::ShowLaunchpadLost ( )
static

Show the lpad_error dialog with the lost session message, unless an error dialog already shows or is about to.

Ghidra address:
NTSC-U/C: 0x00187258
Ghidra address:
PAL: 0x0018b498

◆ DispatchPriv()

bool NetJoinLPadScreen::DispatchPriv ( Message * pMsg)
overridevirtual

Route the messages of the session, the end of the entry, and the controller buttons, and pass on every other message.

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

Reimplemented from FreqScreen.

◆ Title()

const char * NetJoinLPadScreen::Title ( )
inlineoverridevirtual

Report the empty title of the screen.

Returns
An empty string.
Ghidra address:
NTSC-U/C: 0x0035bbc8
Ghidra address:
PAL: 0x003c9720

Reimplemented from FreqScreen.

◆ SetLaunchpad()

void NetJoinLPadScreen::SetLaunchpad ( int nLaunchpadId,
int nLaunchpadWorld )
inline

Choose the session to join.

Parameters
nLaunchpadIdThe first identifier of the session.
nLaunchpadWorldThe second identifier of the session.
Ghidra address:
NTSC-U/C: 0x00186cc8
Ghidra address:
PAL: 0x0018af08

◆ HandleTransitionComplete()

bool NetJoinLPadScreen::HandleTransitionComplete ( UITransitionCompleteMsg * pMsg)

Start joining once the screen has entered, recording the screen it entered from.

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

◆ HandleSuccess()

bool NetJoinLPadScreen::HandleSuccess ( JoinLaunchpadSuccessMsg * pMsg)

Take the settings of the game, clear the chat of the launchpad, and go to it, unless the player cancelled.

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

◆ HandleAborted()

bool NetJoinLPadScreen::HandleAborted ( LaunchpadAbortedMsg * pMsg)

Go back after a cancel, or show the error of the failure.

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

◆ HandleJoypad()

bool NetJoinLPadScreen::HandleJoypad ( JoypadInputMsg * pMsg)

Cancel the attempt when the triangle button goes down.

With a session, the dialog hides its triangle prompt and shows cancel_join_attempt until the session ends. Without one, the screen goes back.

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

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