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().
| 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
-
- 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.
| virtual bool MsgSink::DispatchPriv |
( |
Message * | msg | ) |
|
|
pure virtual |
Handle a message in the derived class.
- Parameters
-
- 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.