wavelength 1.0.0
Loading...
Searching...
No Matches
MsgSink Class Referenceabstract

Receiver of engine messages. More...

#include <msgsink.h>

Inheritance diagram for MsgSink:

Public Member Functions

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 ()
virtual bool Dispatch (Message *pMsg)
 Accept a message.
virtual bool DispatchPriv (Message *pMsg)=0
 Act on a message.
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.
virtual bool Dispatch (Message *msg)
 Handle a message.
virtual bool DispatchPriv (Message *msg)=0
 Handle a message in the derived class.

Detailed Description

Receiver of engine messages.

Receiver of the messages of a MsgSource.

The RTTI includes the class name and records no base. The class declares no data member, and the vptr sits at offset 0 over a four-byte subobject. The vtable at 0x003c7708 runs the type function, the destructor, Dispatch(), and DispatchPriv(), whose entry is the shared pure-virtual stub.

Both members report whether the sink handled the message. MsgSource::SendUntilHandled() stops at the first sink that reports a message as handled, and the front end passes a message on only when a sink does not handle it.

The RTTI records the class. The object is 4 bytes. A derived class provides DispatchPriv().

Constructor & Destructor Documentation

◆ ~MsgSink() [1/2]

virtual MsgSink::~MsgSink ( )
virtual
Ghidra address:
NTSC-U/C: 0x00338948
Ghidra address:
PAL: 0x003a5ef8

◆ ~MsgSink() [2/2]

virtual MsgSink::~MsgSink ( )
virtual

Destroy the sink.

Ghidra address:
0x10013620

Member Function Documentation

◆ operator new() [1/2]

void * MsgSink::operator new ( size_t nSize)
inline

Allocate a sink from the pool heaps under the tag "MsgSink".

No out-of-line body exists. Every allocation of a derived class inlines the call with the default alignment, among them the one in InputMgr's constructor at 0x001182a8.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete() [1/2]

void MsgSink::operator delete ( void * pBlock)
inline

Return a sink to the pool heaps.

No out-of-line body exists. The release branch of every derived destructor inlines the call, among them the one in InputMgr's destructor at 0x00118700.

Parameters
pBlockThe block.

◆ Dispatch() [1/2]

virtual bool MsgSink::Dispatch ( Message * pMsg)
virtual

Accept a message.

The body calls DispatchPriv() through the object's own vptr and reports its result. Classes that route a message elsewhere first override it.

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

Reimplemented in UIComponent, UIManager, UIPanel, and UIScreen.

◆ DispatchPriv() [1/2]

virtual bool MsgSink::DispatchPriv ( Message * pMsg)
pure virtual

Act on a message.

Public rather than protected, because some sinks pass a message to the DispatchPriv() of another sink they store.

Parameters
pMsgThe message.
Returns
Whether the message was handled.

Implemented in ArenaUnlockScreen, AutoSaveDoneScreen, BootScreen, BossUnlockScreen, CardsConnectedScreen, ChatPanel, ChatTextEntry, CheatsManager, CheatsManager, CheckInetTask, ChooseMemCardScreen, ControllerConfigScreen, CopyFreqScreen, CreditsScreen, DeleteFreqScreen, DeleteRemixScreen, DoDNSTask, DuelLogic, ExpressionStick, FormatScreen, FreestyleLapTipScreen, FreqConfirmScreen, FreqCopyDelScreen, FreqMakerCustomScreen, FreqMakerEmblemScreen, FreqMakerErrorScreen, FreqMakerMainScreen, FreqMakerPartConfigScreen, FreqScreen, FreqSelPanel, GameOptionsScreen, HostpadRT, InputMgr, IntroScreen, JoinpadRT, JukeboxScreen, KeyboardKey, KeyboardPanel, LaunchpadRT, ListRemixesScreen, LoadFreqScreen, LoadNetConfigsScreen, LoadRemixScreen, LRButton, MainOptionsScreen, MarketingScreen, MCCheckScreen, MCNetConfigTask, MetaArenaScreen, Metagame, MetaMainScreen, MetaSkillScreen, MetaSongScreen, MetaStartScreen, ModeScreen, MultiEndGameScreen, MultiFreqSelectScreen, MultiGameLogic, MultiLoadFreqScreen, MultiSetupRemixSaveScreen, NetChangePassword, NetChangePasswordScreen, NetChooseIConfigScreen, NetCreateAccount, NetCreateConfigScreen, NetCreateUserScreen, NetDoDownloadScreen, NetDoPlayerSearchScreen, NetDoUploadScreen, NetEndGameScreen, NetEULAScreen, NetGetDownloadsScreen, NetHostAttemptScreen, NetHostingScreen, NetInetConnect, NetInetDisconnect, NetJoinLPadScreen, NetLaunchpadQuitScreen, NetLaunchScreen, NetLobbyConnect, NetLobbyDisconnect, NetLoginScreen, NetLPadPlayerPanel, NetLpadScreen, NetMainLaunchpadsPanel, NetMainLobbiesPanel, NetMainPanel, NetMainPlayersPanel, NetMainScreen, NetNewChatroomScreen, NetParamsScreen, NetPasswordScreen, NetRankedPlayersPanel, NetRankingScreen, NetReadOnlyWarnScreen, NetSearchScreen, NetServerLogin, NetServerSelScreen, NetSortedLaunchpadsPanel, NetSortedScreen, NetSwitchLobbyScreen, NoControllerScreen, NumPlayersScreen, Overlay, OvyChat, PartUnlockScreen, PauseScreen, PlayerSearchResultsScreen, PlaylistPanel, PowerupScreen, PreLaunchScreen, ReadOnlyCheckScreen, ReadOnlySaveScreen, RedbookPlaybackScreen, RemixControllerScreen, RemixCopyDelScreen, RemixCreateModeScreen, RemixDiscardScreen, RemixHUD, RemixLogic, RemixOrFreqScreen, RemixSelectScreen, RemixSongScreen, RemixTypeScreen, SaveEditedFreqScreen, SaveErrorScreen, SaveFreqScreen, SaveRemixScreen, SaveSettingsScreen, SelLoadedFreqScreen, SelRemixDownloadScreen, SelRemixUploadScreen, SetupNameScreen, SetupRemixSaveScreen, ShareRemixScreen, SoloEndGameScreen, SoloGameLogic, TipsScreen, TutorialGameLogic, UIButton, UIComponent, UIList, UIManager, UINavigator, UIPanel, UIScreen, UITextEntry, UnlockScreen, UploadNoteScreen, World, WorldLogic, and XProceedScreen.

◆ operator new() [2/2]

void * MsgSink::operator new ( size_t size)
inline

Allocate from the main heap under the name MsgSink.

◆ operator delete() [2/2]

void MsgSink::operator delete ( void * mem)
inline

Return memory to its heap.

Ghidra address:
0x10014070

◆ Dispatch() [2/2]

virtual bool MsgSink::Dispatch ( Message * msg)
virtual

Handle a message.

Parameters
msgThe message.
Returns
Whether the sink handled the message.
Ghidra address:
0x10013630

Reimplemented in UIComponent, UIManager, UIPanel, and UIScreen.

◆ DispatchPriv() [2/2]

virtual bool MsgSink::DispatchPriv ( Message * msg)
pure virtual

Handle a message in the derived class.

Parameters
msgThe message.
Returns
Whether the sink handled the message.

Implemented in ArenaUnlockScreen, AutoSaveDoneScreen, BootScreen, BossUnlockScreen, CardsConnectedScreen, ChatPanel, ChatTextEntry, CheatsManager, CheatsManager, CheckInetTask, ChooseMemCardScreen, ControllerConfigScreen, CopyFreqScreen, CreditsScreen, DeleteFreqScreen, DeleteRemixScreen, DoDNSTask, DuelLogic, ExpressionStick, FormatScreen, FreestyleLapTipScreen, FreqConfirmScreen, FreqCopyDelScreen, FreqMakerCustomScreen, FreqMakerEmblemScreen, FreqMakerErrorScreen, FreqMakerMainScreen, FreqMakerPartConfigScreen, FreqScreen, FreqSelPanel, GameOptionsScreen, HostpadRT, InputMgr, IntroScreen, JoinpadRT, JukeboxScreen, KeyboardKey, KeyboardPanel, LaunchpadRT, ListRemixesScreen, LoadFreqScreen, LoadNetConfigsScreen, LoadRemixScreen, LRButton, MainOptionsScreen, MarketingScreen, MCCheckScreen, MCNetConfigTask, MetaArenaScreen, Metagame, MetaMainScreen, MetaSkillScreen, MetaSongScreen, MetaStartScreen, ModeScreen, MultiEndGameScreen, MultiFreqSelectScreen, MultiGameLogic, MultiLoadFreqScreen, MultiSetupRemixSaveScreen, NetChangePassword, NetChangePasswordScreen, NetChooseIConfigScreen, NetCreateAccount, NetCreateConfigScreen, NetCreateUserScreen, NetDoDownloadScreen, NetDoPlayerSearchScreen, NetDoUploadScreen, NetEndGameScreen, NetEULAScreen, NetGetDownloadsScreen, NetHostAttemptScreen, NetHostingScreen, NetInetConnect, NetInetDisconnect, NetJoinLPadScreen, NetLaunchpadQuitScreen, NetLaunchScreen, NetLobbyConnect, NetLobbyDisconnect, NetLoginScreen, NetLPadPlayerPanel, NetLpadScreen, NetMainLaunchpadsPanel, NetMainLobbiesPanel, NetMainPanel, NetMainPlayersPanel, NetMainScreen, NetNewChatroomScreen, NetParamsScreen, NetPasswordScreen, NetRankedPlayersPanel, NetRankingScreen, NetReadOnlyWarnScreen, NetSearchScreen, NetServerLogin, NetServerSelScreen, NetSortedLaunchpadsPanel, NetSortedScreen, NetSwitchLobbyScreen, NoControllerScreen, NumPlayersScreen, Overlay, OvyChat, PartUnlockScreen, PauseScreen, PlayerSearchResultsScreen, PlaylistPanel, PowerupScreen, PreLaunchScreen, ReadOnlyCheckScreen, ReadOnlySaveScreen, RedbookPlaybackScreen, RemixControllerScreen, RemixCopyDelScreen, RemixCreateModeScreen, RemixDiscardScreen, RemixHUD, RemixLogic, RemixOrFreqScreen, RemixSelectScreen, RemixSongScreen, RemixTypeScreen, SaveEditedFreqScreen, SaveErrorScreen, SaveFreqScreen, SaveRemixScreen, SaveSettingsScreen, SelLoadedFreqScreen, SelRemixDownloadScreen, SelRemixUploadScreen, SetupNameScreen, SetupRemixSaveScreen, ShareRemixScreen, SoloEndGameScreen, SoloGameLogic, TipsScreen, TutorialGameLogic, UIButton, UIComponent, UIList, UIManager, UINavigator, UIPanel, UIScreen, UITextEntry, UnlockScreen, UploadNoteScreen, World, WorldLogic, and XProceedScreen.


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